{ "openapi": "3.0.0", "info": { "title": "Legacy Search API", "description": "\r\n> Check the new [Search onboarding guide](https://developers.vtex.com/docs/guides/search-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Search and is organized by focusing on the developer's journey.\r\n\r\nThis API lets you search and sort products in the Catalog using Fulltext, Category and Brand search terms. \r\n\r\nRetrieve product data to create custom searches and product shelves.", "contact": {}, "version": "1.0" }, "servers": [ { "url": "https://{accountName}.{environment}.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" }, "environment": { "description": "Environment to use. Used as part of the URL.", "enum": [ "vtexcommercestable" ], "default": "vtexcommercestable" } } } ], "paths": { "/api/catalog_system/pub/products/crossselling/whosawalsosaw/{productId}": { "get": { "tags": [ "CrossSelling" ], "summary": "Get product search of who saw also saw", "description": ">❗ This endpoint is deprecated and may not work as expected. Instead, it returns a list of products from the same category.", "operationId": "ProductSearchWhoSawAlsoSaw", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "productId", "in": "path", "description": "Product unique identifier.", "required": true, "style": "simple", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "productId": "35", "productName": "Kit de Hoegaarden", "brand": "Hoegaarden", "brandId": 2000004, "brandImageUrl": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg", "linkText": "kit-6-cerveja-hoegaarden", "productReference": "000806", "productReferenceCode": null, "categoryId": "1", "productTitle": "", "metaTagDescription": "", "releaseDate": "2020-10-07T00:00:00", "clusterHighlights": { "138": "teste2" }, "productClusters": { "138": "teste2", "143": "NaoPesquisavel", "146": "colecaotestesubcategoria", "161": "merch_import_test1" }, "searchableClusters": { "138": "teste2" }, "categories": [ "/Beers Beers Mesmo/" ], "categoriesIds": [ "/1/" ], "link": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p", "Percentuals": [ "4,9" ], "Percentual": [ "4,9" ], "Total": [ "Percentuals", "Percentual" ], "Teste de Api": [ "a" ], "Ale": [ "1" ], "Teste da Api2": [ "Teste de Api", "Ale" ], "Alcool": [ "Percentual" ], "allSpecifications": [ "Percentuals", "Percentual", "Teste de Api", "Ale" ], "allSpecificationsGroups": [ "Total", "Teste da Api2" ], "description": "", "items": [ { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0000, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null } ] } ], "schema": { "type": "array", "items": { "type": "object", "description": "Information about the product.", "required": [ "productId", "productName", "brand", "brandId", "brandImageUrl", "linkText", "productReference", "productReferenceCode", "categoryId", "productTitle", "metaTagDescription", "releaseDate", "clusterHighlights", "productClusters", "searchableClusters", "categories", "categoriesIds", "link", "Percentuals", "Percentual", "Total", "Teste de Api", "Ale", "Teste da Api2", "Alcool", "allSpecifications", "allSpecificationsGroups", "description", "items" ], "properties": { "productId": { "type": "string", "description": "Product unique identifier." }, "productName": { "type": "string", "description": "Product name." }, "brand": { "type": "string", "description": "Brand name." }, "brandId": { "type": "integer", "description": "Product brand ID." }, "brandImageUrl": { "type": "string", "description": "Product's brand image URL." }, "linkText": { "type": "string", "description": "Product URL." }, "productReference": { "type": "string", "description": "Product reference." }, "productReferenceCode": { "type": "integer", "description": "Product reference ID.", "nullable": true }, "categoryId": { "type": "string", "description": "Product category ID." }, "productTitle": { "type": "string", "description": "Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO." }, "metaTagDescription": { "type": "string", "description": "Brief description of the category. It's recommended that you don't exceed 150 characters so that the search engines can display it correctly in the results page." }, "releaseDate": { "type": "string", "description": "Product release date." }, "clusterHighlights": { "type": "object", "description": "Product clusters highlights. Structure: \"{Product cluster ID}\": \"{Product cluster name}\". Both the key and the value are strings.", "additionalProperties": { "type": "string", "description": "Product cluster ID.", "additionalProperties": { "type": "string", "description": "Product cluster highlight." } } }, "productClusters": { "type": "object", "description": "Product clusters' IDs and names. Structure: \"{Product cluster ID}\": \"{Product cluster name}\". Both the keys and the values are strings.", "additionalProperties": { "type": "string", "description": "Product cluster ID.", "additionalProperties": { "type": "string", "description": "Product cluster name." } } }, "searchableClusters": { "type": "object", "description": "Searchable clusters IDs and names. Structure: \"{Searchable cluster ID}\": \"{Searchable cluster name}\". Both the keys and the values are strings.", "additionalProperties": { "type": "string", "description": "Product cluster ID.", "additionalProperties": { "type": "string", "description": "Product cluster name." } } }, "categories": { "type": "array", "description": "Array of the product's categories URLs.", "items": { "type": "string", "description": "The product's category URL." } }, "categoriesIds": { "type": "array", "description": "Array of the product's categories IDs.", "items": { "type": "string", "description": "Product category ID." } }, "link": { "type": "string", "description": "Product URL." }, "allSpecifications": { "type": "array", "description": "Array of the product's specifications.", "items": { "type": "string", "description": "Product specification." } }, "allSpecificationsGroups": { "type": "array", "description": "Array of the product's specifications groups.", "items": { "type": "string", "description": "Product specification group." } }, "description": { "type": "string", "description": "Description of the main information related to the product. A simple and easy to understand summary for the customer.", "nullable": true }, "items": { "type": "array", "description": "Array containing the product SKU general information.", "items": { "type": "object", "description": "Information about the SKU.", "required": [ "itemId", "name", "nameComplete", "complementName", "ean", "referenceId", "measurementUnit", "unitMultiplier", "modalType", "isKit", "kitItems", "images", "sellers", "Videos", "estimatedDateArrival" ], "properties": { "itemId": { "type": "string", "description": "SKU ID." }, "name": { "type": "string", "description": "SKU name." }, "nameComplete": { "type": "string", "description": "SKU complete name." }, "complementName": { "type": "string", "description": "SKU complement name." }, "ean": { "type": "string", "description": "SKU unique identification code (barcode), accepts up to 13 numerical characters." }, "referenceId": { "type": "array", "description": "Reference code ID.", "items": { "type": "object", "description": "Reference code key and value.", "required": [ "Key", "Value" ], "properties": { "Key": { "type": "string", "description": "Reference code key." }, "Value": { "type": "string", "description": "Unique reference code used internally for organizational purposes." } } } }, "measurementUnit": { "type": "string", "description": "Measurement unit. This field should only be used when it is necessary to convert the unit of measure for sale. In common cases, use `un` (unit).\n\rThe acceptables values are:\n\r- `un`: Unit\n\r- `kg`: Kilogram\n\r- `g`: Gram\n\r- `mg`: Milligram\n\r- `m`: Meter\n\r- `m²`: Square meter\n\r- `m³`: Cubic meter\n\r- `cm`: Centimeter\n\r- `cm²`: Square centimeter\n\r- `cm³`: Cubic centimeter\n\r- `mm`: Millimeter\n\r- `mm²`: Square millimeter\n\r- `mm³`: Cubic millimeter\n\r- `oz`: Ounce\n\r- `lb`: Pound\n\r- `ft`: Foot\n\r- `ft²`: Square foot\n\r- `ft³`: Cubic foot\n\r- `in`: Inch\n\r- `in²`: Square inch\n\r- `in³`: Cubic inch", "enum": [ "un", "kg", "g", "mg", "m", "m²", "m³", "cm", "cm²", "cm³", "mm", "mm²", "mm³", "oz", "lb", "ft", "ft²", "ft³", "in", "in²", "in³" ] }, "unitMultiplier": { "type": "number", "description": "Numerical unit that multiplies the selected quantity of the product when it's inserted in the cart." }, "modalType": { "type": "string", "description": "Modal type.", "nullable": true }, "isKit": { "type": "boolean", "description": "Defines if the SKU is part of a kit (`true`) or not (`false`)." }, "kitItems": { "type": "array", "description": "Array with information about SKU components from a kit.", "items": { "type": "object", "description": "Information about a given SKU component from a kit.", "required": [ "itemId", "amount" ], "properties": { "itemId": { "type": "string", "description": "SKU kit component ID." }, "amount": { "type": "integer", "description": "Amount of the SKU components in the kit." } } } }, "images": { "type": "array", "description": "Array of information about the SKU images.", "items": { "type": "object", "description": "Information about a given SKU image.", "required": [ "imageId", "imageLabel", "imageTag", "imageUrl", "imageText", "imageLastModified" ], "properties": { "imageId": { "type": "string", "description": "Image ID." }, "imageLabel": { "type": "string", "description": "Image label." }, "imageTag": { "type": "string", "description": "Image tag." }, "imageUrl": { "type": "string", "description": "Image URL." }, "imageText": { "type": "string", "description": "Image text.", "nullable": true }, "imageLastModified": { "type": "string", "description": "Date and time of the last update of the image." } } } }, "sellers": { "type": "array", "description": "Array of SKU sellers.", "items": { "type": "object", "description": "Information about a given seller.", "required": [ "sellerId", "sellerName", "addToCartLink", "sellerDefault", "commertialOffer" ], "properties": { "sellerId": { "type": "string", "description": "SKU seller ID." }, "sellerName": { "type": "string", "description": "SKU seller name." }, "addToCartLink": { "type": "string", "description": "URL to add the product to the cart." }, "sellerDefault": { "type": "boolean", "description": "Defines if the seller is default (`true`) or not (`false`)." }, "commertialOffer": { "type": "object", "description": "AKA Commertial Condition.", "required": [ "DeliverySlaSamplesPerRegion", "Installments", "DiscountHighLight", "GiftSkuIds", "Teasers", "BuyTogether", "ItemMetadataAttachment", "Price", "ListPrice", "PriceWithoutDiscount", "RewardValue", "PriceValidUntil", "AvailableQuantity", "IsAvailable", "Tax", "SaleChannel", "DeliverySlaSamples", "GetInfoErrorMessage", "CacheVersionUsedToCallCheckout", "PaymentOptions" ], "properties": { "DeliverySlaSamplesPerRegion": { "type": "object", "description": "Delivery SLA samples per region.", "properties": { "0": { "type": "object", "description": "Delivery SLA ID.", "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "items": { "type": "string", "description": "Delivery SLA type." } }, "Region": { "type": "string", "description": "Delivery SLA region.", "nullable": true } } } } }, "Installments": { "type": "array", "description": "Installments options.", "items": { "type": "object", "description": "Information about a given installment option.", "required": [ "Value", "InterestRate", "TotalValuePlusInterestRate", "NumberOfInstallments", "PaymentSystemName", "PaymentSystemGroupName", "Name" ], "properties": { "Value": { "type": "number", "description": "Value of the installment." }, "InterestRate": { "type": "number", "description": "Interest rate of the installment." }, "TotalValuePlusInterestRate": { "type": "number", "description": "Total value plus interest rate of the installment." }, "NumberOfInstallments": { "type": "integer", "description": "Number of the installment." }, "PaymentSystemName": { "type": "string", "description": "Payment system name of the installment." }, "PaymentSystemGroupName": { "type": "string", "description": "Payment system group name of the installment." }, "Name": { "type": "string", "description": "Name of the installment." } } } }, "DiscountHighLight": { "type": "array", "description": "Discount hightlights.", "items": { "type": "string", "description": "Discount hightlight name." } }, "GiftSkuIds": { "type": "array", "description": "Array of SKU gifts IDs.", "items": { "type": "string", "description": "SKU gift ID." } }, "Teasers": { "type": "array", "description": "List with teasers information.", "items": { "type": "object", "description": "Information about a given teaser.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}`.", "properties": { "{field}": { "type": "string", "description": "General value." } } }, "k__BackingField": { "type": "object", "description": "Conditions.", "properties": { "k__BackingField": { "type": "integer", "description": "Minimum quantity." }, "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } }, "k__BackingField": { "type": "object", "description": "Effects.", "properties": { "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } } } } }, "PromotionTeasers": { "type": "array", "description": "List with promotions teasers information.", "items": { "type": "object", "description": "Information about a given promotion teaser.", "properties": { "Name": { "type": "string", "description": "Name." }, "GeneralValues": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}`.", "properties": { "{field}": { "type": "string", "description": "General value." } } }, "Conditions": { "type": "object", "description": "Conditions.", "properties": { "MinimumQuantity": { "type": "integer", "description": "Minimum quantity." }, "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } }, "Effects": { "type": "object", "description": "Effects.", "properties": { "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } } } } }, "BuyTogether": { "type": "array", "description": "Array of other products that can be bought together with the product in question.", "items": { "type": "string", "description": "Product ID." } }, "ItemMetadataAttachment": { "description": "Item metadata attachment.", "type": "array", "items": { "description": "Item metadata attachment information.", "type": "object", "properties": { "Name": { "description": "SKU name.", "type": "string" }, "NameComplete": { "description": "Complete name of the product combined with the SKU name.", "type": "string" }, "MainImage": { "description": "Main image URL.", "type": "string" }, "BrandName": { "description": "Brand name.", "type": "string" }, "CategoryId": { "description": "Category unique identifier.", "type": "number" }, "ProductId": { "description": "Product unique identifier.", "type": "number" }, "id": { "description": "SKU unique identifier.", "type": "string" }, "seller": { "description": "Seller unique identifier.", "type": "string" }, "assemblyOptions": { "description": "Assembly options attachment.", "type": "array", "items": { "description": "Assembly options attachment information.", "type": "object", "properties": { "id": { "description": "Attachment unique identifier.", "type": "string" }, "name": { "description": "Attachment name.", "type": "string" }, "required": { "description": "Defines whether the attachment is required (`true`) or not (`false`).", "type": "boolean" }, "inputValues": { "description": "Input values information.", "type": "object", "additionalProperties": true } } } } } } }, "Price": { "type": "number", "description": "Price of the product." }, "ListPrice": { "type": "number", "description": "List price of the product." }, "PriceWithoutDiscount": { "type": "number", "description": "Price of the product without discount." }, "RewardValue": { "type": "number", "description": "Reward value of the product." }, "PriceValidUntil": { "type": "string", "description": "Price of the product valid until a certain date." }, "AvailableQuantity": { "type": "integer", "description": "Available quantity. Use the `IsAvailable` field instead." }, "IsAvailable": { "type": "boolean", "description": "Defines if the product is available (`true`) or not (`false`)." }, "Tax": { "type": "number", "description": "Tax of the product." }, "SaleChannel": { "type": "integer", "description": "Trade policy which the product is contained." }, "DeliverySlaSamples": { "type": "array", "description": "Delivery SLA samples information.", "items": { "type": "object", "description": "Information about a given delivery SLA sample.", "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "items": { "type": "string", "description": "Delivery SLA type." } }, "Region": { "type": "string", "description": "Delivery SLA region.", "nullable": true } } } }, "GetInfoErrorMessage": { "type": "string", "description": "Get info error message.", "nullable": true }, "CacheVersionUsedToCallCheckout": { "type": "string", "description": "Cache version used to call checkout." }, "PaymentOptions": { "type": "object", "description": "Payment options.", "required": [ "installmentOptions", "paymentSystems", "payments", "giftCards", "giftCardMessages", "availableAccounts", "availableTokens" ], "properties": { "installmentOptions": { "type": "array", "description": "Information about installment options.", "items": { "type": "object", "description": "Information about a given installment.", "required": [ "paymentSystem", "bin", "paymentName", "paymentGroupName", "value", "installments" ], "properties": { "paymentSystem": { "type": "string", "description": "Payment system." }, "bin": { "type": "string", "description": "First six digits of the card number.", "nullable": true }, "paymentName": { "type": "string", "description": "Payment name." }, "paymentGroupName": { "type": "string", "description": "Payment group name." }, "value": { "type": "integer", "description": "Installment value." }, "installments": { "type": "array", "description": "Information about installments.", "items": { "type": "object", "description": "Information about a given installment.", "required": [ "count", "hasInterestRate", "interestRate", "value", "total", "sellerMerchantInstallments" ], "properties": { "count": { "type": "integer", "description": "Installment count." }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate." }, "interestRate": { "type": "integer", "description": "Interest rate." }, "value": { "type": "integer", "description": "Value." }, "total": { "type": "integer", "description": "Total." }, "sellerMerchantInstallments": { "type": "array", "description": "List of seller merchant installments.", "items": { "type": "object", "description": "Seller merchant installment.", "required": [ "id", "count", "hasInterestRate", "interestRate", "value", "total" ], "properties": { "id": { "type": "string", "description": "ID." }, "count": { "type": "integer", "description": "Count." }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate." }, "interestRate": { "type": "integer", "description": "Interest rate." }, "value": { "type": "integer", "description": "Value." }, "total": { "type": "integer", "description": "Total." } } } } } } } } } }, "paymentSystems": { "type": "array", "description": "Payment systems information.", "items": { "type": "object", "description": "Information about a given payment system.", "required": [ "id", "name", "groupName", "validator", "stringId", "template", "requiresDocument", "isCustom", "description", "requiresAuthentication", "dueDate", "availablePayments" ], "properties": { "id": { "type": "integer", "description": "ID." }, "name": { "type": "string", "description": "Name." }, "groupName": { "type": "string", "description": "Group name." }, "validator": { "type": "string", "description": "Validator.", "nullable": true }, "stringId": { "type": "string", "description": "String ID." }, "template": { "type": "string", "description": "Template." }, "requiresDocument": { "type": "boolean", "description": "If requires document or not." }, "isCustom": { "type": "boolean", "description": "If is custom or not." }, "description": { "type": "string", "description": "Description.", "nullable": true }, "requiresAuthentication": { "type": "boolean", "description": "If requires authentication." }, "dueDate": { "type": "string", "description": "Due date." }, "availablePayments": { "type": "string", "description": "Available payments.", "nullable": true } } } }, "payments": { "type": "array", "description": "Payments." }, "giftCards": { "type": "array", "description": "GiftCards." }, "giftCardMessages": { "type": "array", "description": "GiftCardMessages." }, "availableAccounts": { "type": "array", "description": "Available accounts." }, "availableTokens": { "type": "array", "description": "Available tokens.", "items": { "type": "string", "description": "Available token name." } } } } } } } } }, "Videos": { "type": "array", "description": "Videos information.", "items": { "type": "string", "description": "Video URL." } }, "estimatedDateArrival": { "type": "string", "description": "Estimated date arrival.", "nullable": true } } } } } } } } } } }, "deprecated": true } }, "/api/catalog_system/pub/products/crossselling/whosawalsobought/{productId}": { "get": { "tags": [ "CrossSelling" ], "summary": "Get product search of who saw also bought", "description": ">❗ This endpoint is deprecated and may not work as expected. Instead, it returns a list of products from the same category.", "operationId": "ProductSearchWhoSawAlsoBought", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "productId", "in": "path", "description": "Product unique identifier.", "required": true, "style": "simple", "schema": { "type": "string", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "productId": "35", "productName": "Kit de Hoegaarden", "brand": "Hoegaarden", "brandId": 2000004, "brandImageUrl": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg", "linkText": "hoegaarden-6-pack-beer-kit", "productReference": "000806", "productReferenceCode": 1234, "categoryId": "1", "productTitle": "Hoegaarden 6 Pack Beer Kit", "metaTagDescription": "Category for Beers", "releaseDate": "2025-05-07T00:00:00", "clusterHighlights": { "138": "teste2" }, "productClusters": { "138": "teste2", "143": "NaoPesquisavel", "146": "colecaotestesubcategoria", "161": "merch_import_test1" }, "searchableClusters": { "138": "teste2" }, "categories": [ "/Beers Beers Mesmo/" ], "categoriesIds": [ "/1/" ], "link": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p", "Percentuals": [ "4,9" ], "Percentual": [ "4,9" ], "Total": [ "Percentuals", "Percentual" ], "Teste de Api": [ "a" ], "Ale": [ "1" ], "Teste da Api2": [ "Teste de Api", "Ale" ], "Alcool": [ "Percentual" ], "allSpecifications": [ "Percentuals", "Percentual", "Teste de Api", "Ale" ], "allSpecificationsGroups": [ "Total", "Teste da Api2" ], "description": null, "items": [ { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0000, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": null, "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2025-03-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null } ] } ], "schema": { "type": "array", "items": { "type": "object", "description": "Object with product search information.", "required": [ "productId", "productName", "brand", "brandId", "brandImageUrl", "linkText", "productReference", "productReferenceCode", "categoryId", "productTitle", "metaTagDescription", "releaseDate", "clusterHighlights", "productClusters", "searchableClusters", "categories", "categoriesIds", "link", "Percentuals", "Percentual", "Total", "Teste de Api", "Ale", "Teste da Api2", "Alcool", "allSpecifications", "allSpecificationsGroups", "description", "items" ], "properties": { "productId": { "type": "string", "description": "Product unique identifier." }, "productName": { "type": "string", "description": "Product name." }, "brand": { "type": "string", "description": "Brand name." }, "brandId": { "type": "integer", "description": "Product brand ID." }, "brandImageUrl": { "type": "string", "description": "Product's brand image URL." }, "linkText": { "type": "string", "description": "Product URL." }, "productReference": { "type": "string", "description": "Product reference." }, "productReferenceCode": { "type": "integer", "description": "Product reference ID.", "nullable": true }, "categoryId": { "type": "string", "description": "Product category ID." }, "productTitle": { "type": "string", "description": "Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO." }, "metaTagDescription": { "type": "string", "description": "Brief description of the category. It's recommended that you don't exceed 150 characters so that the search engines can display it correctly in the results page." }, "releaseDate": { "type": "string", "description": "Product release date." }, "clusterHighlights": { "type": "object", "description": "Cluster highlight ID and name." }, "productClusters": { "type": "object", "description": "Product clusters' IDs and names.", "additionalProperties": true }, "searchableClusters": { "type": "object", "description": "Searchable clusters IDs and names.", "additionalProperties": true }, "categories": { "type": "array", "description": "Array of the product's categories URLs.", "items": { "type": "string", "description": "Product category URL." } }, "categoriesIds": { "type": "array", "description": "Array of the product's categories IDs.", "items": { "type": "string", "description": "Product category ID." } }, "link": { "type": "string", "description": "Product URL." }, "allSpecifications": { "type": "array", "description": "Array of the product's specifications.", "items": { "type": "string", "description": "Product specification." } }, "allSpecificationsGroups": { "type": "array", "description": "Array of the product's specifications groups.", "items": { "type": "string", "description": "Product specification group." } }, "description": { "type": "string", "nullable": true, "description": "Description of the main information related to the product. A simple and easy to understand summary for the customer." }, "items": { "type": "array", "description": "Array containing the product SKU general information.", "items": { "type": "object", "description": "Product SKU general information object.", "required": [ "itemId", "name", "nameComplete", "complementName", "ean", "referenceId", "measurementUnit", "unitMultiplier", "modalType", "isKit", "kitItems", "images", "sellers", "Videos", "estimatedDateArrival" ], "properties": { "itemId": { "type": "string", "description": "SKU ID." }, "name": { "type": "string", "description": "SKU name." }, "nameComplete": { "type": "string", "description": "SKU complete name." }, "complementName": { "type": "string", "description": "SKU complement name." }, "ean": { "type": "string", "description": "SKU unique identification code (barcode), accepts up to 13 numerical characters." }, "referenceId": { "type": "array", "description": "Reference code ID.", "items": { "type": "object", "required": [ "Key", "Value" ], "properties": { "Key": { "type": "string", "description": "Reference Code." }, "Value": { "type": "string", "description": "Unique reference code used internally for organizational purposes." } } } }, "measurementUnit": { "type": "string", "description": "Used only in cases when you need to convert the unit of measure for sale. In common cases, use 'un'." }, "unitMultiplier": { "type": "number", "description": "Numerical unit that multiplies the selected quantity of the product when inserted in the cart." }, "modalType": { "type": "string", "description": "Modal Type.", "nullable": true }, "isKit": { "type": "boolean", "description": "If the SKU is part of a kit." }, "kitItems": { "type": "array", "description": "Array with information of SKUs components from a Kit.", "items": { "type": "object", "description": "Information about a given SKU component.", "required": [ "itemId", "amount" ], "properties": { "itemId": { "type": "string", "description": "SKU kit component ID." }, "amount": { "type": "integer", "description": "Amount of the SKU component in the kit." } } } }, "images": { "type": "array", "description": "Array of information about the SKU image.", "items": { "type": "object", "description": "Information about a given SKU image.", "required": [ "imageId", "imageLabel", "imageTag", "imageUrl", "imageText", "imageLastModified" ], "properties": { "imageId": { "type": "string", "description": "Image ID." }, "imageLabel": { "type": "string", "description": "Image label.", "nullable": true }, "imageTag": { "type": "string", "description": "Image tag." }, "imageUrl": { "type": "string", "description": "Image URL." }, "imageText": { "type": "string", "description": "Image text.", "nullable": true }, "imageLastModified": { "type": "string", "description": "Date and time of the last update of the image." } } } }, "sellers": { "type": "array", "description": "Array of SKU sellers.", "items": { "type": "object", "description": "Information about a given SKU seller.", "required": [ "sellerId", "sellerName", "addToCartLink", "sellerDefault", "commertialOffer" ], "properties": { "sellerId": { "type": "string", "description": "SKU seller ID." }, "sellerName": { "type": "string", "description": "SKU seller name." }, "addToCartLink": { "type": "string", "description": "URL to add the product to the cart." }, "sellerDefault": { "type": "boolean", "description": "If the seller is default or not." }, "commertialOffer": { "type": "object", "description": "Also known as Commercial Condition.", "required": [ "DeliverySlaSamplesPerRegion", "Installments", "DiscountHighLight", "GiftSkuIds", "Teasers", "BuyTogether", "ItemMetadataAttachment", "Price", "ListPrice", "PriceWithoutDiscount", "RewardValue", "PriceValidUntil", "AvailableQuantity", "IsAvailable", "Tax", "SaleChannel", "DeliverySlaSamples", "GetInfoErrorMessage", "CacheVersionUsedToCallCheckout", "PaymentOptions" ], "properties": { "DeliverySlaSamplesPerRegion": { "type": "object", "description": "Delivery SLA samples per region.", "properties": { "0": { "type": "object", "description": "Delivery SLA ID.", "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types." }, "Region": { "type": "string", "description": "Region.", "nullable": true } } } } }, "Installments": { "type": "array", "description": "Installments options.", "items": { "type": "object", "required": [ "Value", "InterestRate", "TotalValuePlusInterestRate", "NumberOfInstallments", "PaymentSystemName", "PaymentSystemGroupName", "Name" ], "properties": { "Value": { "type": "number", "description": "Value of the installment." }, "InterestRate": { "type": "number", "description": "Interest rate of the installment." }, "TotalValuePlusInterestRate": { "type": "number", "description": "Total value plus interest rate of the installment." }, "NumberOfInstallments": { "type": "integer", "description": "Number of the installment." }, "PaymentSystemName": { "type": "string", "description": "Payment system name of the installment." }, "PaymentSystemGroupName": { "type": "string", "description": "Payment system group name of the installment." }, "Name": { "type": "string", "description": "Name of the installment." } } } }, "DiscountHighLight": { "type": "array", "description": "Discount highlight." }, "GiftSkuIds": { "type": "array", "description": "Array of SKU gifts IDs." }, "Teasers": { "type": "array", "description": "List with promotions teasers.", "items": { "type": "object", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}`.", "properties": { "{field}": { "type": "string", "description": "General value." } } }, "k__BackingField": { "type": "object", "description": "Conditions.", "properties": { "k__BackingField": { "type": "integer", "description": "Minimum quantity." }, "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } }, "k__BackingField": { "type": "object", "description": "Effects.", "properties": { "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } } } } }, "PromotionTeasers": { "type": "array", "description": "List with promotions teasers.", "items": { "type": "object", "description": "Information about a given promotion teaser.", "properties": { "Name": { "type": "string", "description": "Name." }, "GeneralValues": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}`.", "properties": { "{field}": { "type": "string", "description": "General value." } } }, "Conditions": { "type": "object", "description": "Conditions.", "properties": { "MinimumQuantity": { "type": "integer", "description": "Minimum quantity." }, "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } }, "Effects": { "type": "object", "description": "Effects.", "properties": { "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } } } } }, "BuyTogether": { "type": "array", "description": "Array of other products that can be bought together with the product in question." }, "ItemMetadataAttachment": { "type": "array", "description": "Item metadata attachment." }, "Price": { "type": "number", "description": "Price of the product." }, "ListPrice": { "type": "number", "description": "List price of the product." }, "PriceWithoutDiscount": { "type": "number", "description": "Price of the product without discount." }, "RewardValue": { "type": "number", "description": "Reward value of the product." }, "PriceValidUntil": { "type": "string", "description": "Price of the product valid until a certain date." }, "AvailableQuantity": { "type": "integer", "description": "Use the `IsAvailable` field instead." }, "IsAvailable": { "type": "boolean", "description": "If the product is available or not." }, "Tax": { "type": "number", "description": "Tax of the product." }, "SaleChannel": { "type": "integer", "description": "Trade policy which the product is contained." }, "DeliverySlaSamples": { "type": "array", "description": "Delivery SLA samples.", "items": { "type": "object", "description": "Information about a given SLA sample.", "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "nullable": true }, "Region": { "type": "string", "description": "Region.", "nullable": true } } } }, "GetInfoErrorMessage": { "type": "string", "description": "Get info error message.", "nullable": true }, "CacheVersionUsedToCallCheckout": { "type": "string", "description": "Cache version used to call checkout." }, "PaymentOptions": { "type": "object", "description": "Payment options.", "required": [ "installmentOptions", "paymentSystems", "payments", "giftCards", "giftCardMessages", "availableAccounts", "availableTokens" ], "properties": { "installmentOptions": { "type": "array", "description": "Installment options.", "items": { "type": "object", "description": "Information about an installment option.", "required": [ "paymentSystem", "bin", "paymentName", "paymentGroupName", "value", "installments" ], "properties": { "paymentSystem": { "type": "string", "description": "Payment system." }, "bin": { "type": "string", "description": "Bin.", "nullable": true }, "paymentName": { "type": "string", "description": "Payment name." }, "paymentGroupName": { "type": "string", "description": "Payment group name." }, "value": { "type": "integer", "description": "Value." }, "installments": { "type": "array", "description": "List of installments.", "items": { "type": "object", "description": "Installment object.", "required": [ "count", "hasInterestRate", "interestRate", "value", "total", "sellerMerchantInstallments" ], "properties": { "count": { "type": "integer", "description": "Count." }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate." }, "interestRate": { "type": "integer", "description": "Interest rate." }, "value": { "type": "integer", "description": "Value." }, "total": { "type": "integer", "description": "Total." }, "sellerMerchantInstallments": { "type": "array", "description": "Seller merchant installments.", "items": { "type": "object", "description": "Information about a given seller merchant installment.", "required": [ "id", "count", "hasInterestRate", "interestRate", "value", "total" ], "properties": { "id": { "type": "string", "description": "ID." }, "count": { "type": "integer", "description": "Count." }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate." }, "interestRate": { "type": "integer", "description": "Interest rate." }, "value": { "type": "integer", "description": "Value." }, "total": { "type": "integer", "description": "Total." } } } } } } } } } }, "paymentSystems": { "type": "array", "description": "Payment systems.", "items": { "type": "object", "example": { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, "required": [ "id", "name", "groupName", "validator", "stringId", "template", "requiresDocument", "isCustom", "description", "requiresAuthentication", "dueDate", "availablePayments" ], "properties": { "id": { "type": "integer", "description": "ID.", "example": 17 }, "name": { "type": "string", "description": "Name.", "example": "Promissory" }, "groupName": { "type": "string", "description": "Group name.", "example": "promissoryPaymentGroup" }, "validator": { "type": "string", "description": "Validator.", "nullable": true, "example": "" }, "stringId": { "type": "string", "description": "String ID.", "example": "17" }, "template": { "type": "string", "description": "Template.", "example": "promissoryPaymentGroup-template" }, "requiresDocument": { "type": "boolean", "description": "If requires document or not.", "example": false }, "isCustom": { "type": "boolean", "description": "If is custom or not.", "example": false }, "description": { "type": "string", "description": "Description.", "nullable": true, "example": "" }, "requiresAuthentication": { "type": "boolean", "description": "If requires authentication.", "example": false }, "dueDate": { "type": "string", "description": "Due date.", "example": "2021-07-01T18:43:00.0264384Z" }, "availablePayments": { "type": "string", "description": "Available payments.", "nullable": true, "example": "" } } } }, "payments": { "type": "array", "description": "Payments.", "example": [] }, "giftCards": { "type": "array", "description": "GiftCards.", "example": [] }, "giftCardMessages": { "type": "array", "description": "GiftCardMessages.", "example": [] }, "availableAccounts": { "type": "array", "description": "Available accounts.", "example": [] }, "availableTokens": { "type": "array", "description": "Available tokens.", "example": [] } } } } } } } }, "Videos": { "type": "array", "description": "Videos.", "nullable": true, "items": { "type": "string", "description": "Video URL." } }, "estimatedDateArrival": { "type": "string", "description": "Estimated date arrival.", "nullable": true } } } } } } } } } } }, "deprecated": true } }, "/api/catalog_system/pub/products/crossselling/whoboughtalsobought/{productId}": { "get": { "tags": [ "CrossSelling" ], "summary": "Get product search of who bought also bought", "description": ">❗ This endpoint is deprecated and may not work as expected. Instead, it returns a list of products from the same category.", "operationId": "ProductSearchWhoBoughtAlsoBought", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "productId", "in": "path", "description": "Product unique identifier.", "required": true, "style": "simple", "schema": { "type": "string", "example": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "productId": "35", "productName": "Kit de Hoegaarden", "brand": "Hoegaarden", "brandId": 2000004, "brandImageUrl": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg", "linkText": "kit-6-cerveja-hoegaarden", "productReference": "000806", "productReferenceCode": null, "categoryId": "1", "productTitle": "", "metaTagDescription": "", "releaseDate": "2020-10-07T00:00:00", "clusterHighlights": { "138": "teste2" }, "productClusters": { "138": "teste2", "143": "NaoPesquisavel", "146": "colecaotestesubcategoria", "161": "merch_import_test1" }, "searchableClusters": { "138": "teste2" }, "categories": [ "/Beers Beers Mesmo/" ], "categoriesIds": [ "/1/" ], "link": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p", "Percentuals": [ "4,9" ], "Percentual": [ "4,9" ], "Total": [ "Percentuals", "Percentual" ], "Teste de Api": [ "a" ], "Ale": [ "1" ], "Teste da Api2": [ "Teste de Api", "Ale" ], "Alcool": [ "Percentual" ], "allSpecifications": [ "Percentuals", "Percentual", "Teste de Api", "Ale" ], "allSpecificationsGroups": [ "Total", "Teste da Api2" ], "description": "", "items": [ { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0000, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null } ] } ], "schema": { "type": "array", "items": { "type": "object", "required": [ "productId", "productName", "brand", "brandId", "brandImageUrl", "linkText", "productReference", "productReferenceCode", "categoryId", "productTitle", "metaTagDescription", "releaseDate", "clusterHighlights", "productClusters", "searchableClusters", "categories", "categoriesIds", "link", "Percentuals", "Percentual", "Total", "Teste de Api", "Ale", "Teste da Api2", "Alcool", "allSpecifications", "allSpecificationsGroups", "description", "items" ], "properties": { "productId": { "type": "string", "description": "Product unique identifier.", "example": "35" }, "productName": { "type": "string", "description": "Product name.", "example": "Kit de Hoegaarden" }, "brand": { "type": "string", "description": "Brand name.", "example": "Hoegaarden" }, "brandId": { "type": "integer", "description": "Product brand ID.", "example": 2000004 }, "brandImageUrl": { "type": "string", "description": "Product's brand image URL.", "example": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg" }, "linkText": { "type": "string", "description": "Product URL.", "example": "kit-6-cerveja-hoegaarden" }, "productReference": { "type": "string", "description": "Product reference.", "example": "000806" }, "productReferenceCode": { "type": "integer", "description": "Product reference ID.", "nullable": true, "example": 1234 }, "categoryId": { "type": "string", "description": "Product category ID.", "example": "1" }, "productTitle": { "type": "string", "description": "Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO.", "example": "Kit 6 cerveja Hoegaarden" }, "metaTagDescription": { "type": "string", "description": "Brief description of the category. It's recommended that you don't exceed 150 characters so that the search engines can display it correctly in the results page.", "example": "Category for Beers" }, "releaseDate": { "type": "string", "description": "Product release date.", "example": "2020-10-07T00:00:00" }, "clusterHighlights": { "type": "object", "description": "Cluster highlight ID and name.", "example": { "138": "teste2" } }, "productClusters": { "type": "object", "description": "Product clusters' IDs and names.", "example": { "138": "teste2", "143": "NaoPesquisavel", "146": "colecaotestesubcategoria", "161": "merch_import_test1" } }, "searchableClusters": { "type": "object", "description": "Searchable clusters IDs and names.", "example": { "138": "teste2" } }, "categories": { "type": "array", "description": "Array of the product's categories URLs.", "example": [ "/Beers Beers Mesmo/" ] }, "categoriesIds": { "type": "array", "description": "Array of the product's categories IDs.", "example": [ "/1/" ] }, "link": { "type": "string", "description": "Product URL.", "example": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p" }, "allSpecifications": { "type": "array", "description": "Array of the product's specifications.", "example": [ "Percentuals", "Percentual" ], "items": { "type": "string", "description": "Product specification.", "example": "Percentual" } }, "allSpecificationsGroups": { "type": "array", "description": "Array of the product's specifications groups.", "example": [ "Total", "Teste da Api2" ], "items": { "type": "string", "description": "Product specification group.", "example": "Teste da Api2" } }, "description": { "type": "string", "description": "Description of the main information related to the product. A simple and easy to understand summary for the customer.", "example": "Description example", "nullable": true }, "items": { "type": "array", "description": "Array containing the product SKU general information.", "example": [ { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null } ], "items": { "type": "object", "example": { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null }, "required": [ "itemId", "name", "nameComplete", "complementName", "ean", "referenceId", "measurementUnit", "unitMultiplier", "modalType", "isKit", "kitItems", "images", "sellers", "Videos", "estimatedDateArrival" ], "properties": { "itemId": { "type": "string", "description": "SKU ID.", "example": "310118469" }, "name": { "type": "string", "description": "SKU name.", "example": "Kit com 6" }, "nameComplete": { "type": "string", "description": "SKU complete name.", "example": "Kit de Hoegaarden Kit com 6" }, "complementName": { "type": "string", "description": "SKU complement name.", "example": "Complement name" }, "ean": { "type": "string", "description": "SKU unique identification code (barcode), accepts up to 13 numerical characters.", "example": "12345567" }, "referenceId": { "type": "array", "description": "Reference code ID.", "example": [ { "Key": "RefId", "Value": "000806" } ], "items": { "type": "object", "example": { "Key": "RefId", "Value": "000806" }, "required": [ "Key", "Value" ], "properties": { "Key": { "type": "string", "description": "Reference Code.", "example": "RefId" }, "Value": { "type": "string", "description": "Unique reference code used internally for organizational purposes.", "example": "000806" } } } }, "measurementUnit": { "type": "string", "description": "Used only in cases when you need to convert the unit of measure for sale. In common cases, use 'un'.", "example": "un" }, "unitMultiplier": { "type": "number", "description": "numerical unit that multiplies the selected quantity of the product when it is inserted in the cart.", "example": 1.0 }, "modalType": { "type": "string", "description": "Modal Type.", "nullable": true, "example": "Modal Type test" }, "isKit": { "type": "boolean", "description": "If the SKU is part of a kit.", "example": true }, "kitItems": { "type": "array", "description": "Array with information of SKUs components from a Kit.", "example": [ { "itemId": "310118466", "amount": 6 } ], "items": { "type": "object", "example": { "itemId": "310118466", "amount": 6 }, "required": [ "itemId", "amount" ], "properties": { "itemId": { "type": "string", "description": "SKU kit component ID.", "example": "310118466" }, "amount": { "type": "integer", "description": "Amount of the SKU component in the kit.", "example": 6 } } } }, "images": { "type": "array", "description": "Array of information about the SKU image.", "example": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "items": { "type": "object", "example": { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" }, "required": [ "imageId", "imageLabel", "imageTag", "imageUrl", "imageText", "imageLastModified" ], "properties": { "imageId": { "type": "string", "description": "Image ID.", "example": "155489" }, "imageLabel": { "type": "string", "description": "Image label.", "example": "Label test" }, "imageTag": { "type": "string", "description": "Image tag.", "example": "\"hoegaarden-kit\"" }, "imageUrl": { "type": "string", "description": "Image URL.", "example": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000" }, "imageText": { "type": "string", "description": "Image text.", "nullable": true, "example": "hoegaarden-kit" }, "imageLastModified": { "type": "string", "description": "Date and time of the last update of the image.", "example": "2020-10-07T12:49:27.5800000Z" } } } }, "sellers": { "type": "array", "description": "Array of SKU sellers.", "example": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "items": { "type": "object", "example": { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } }, "required": [ "sellerId", "sellerName", "addToCartLink", "sellerDefault", "commertialOffer" ], "properties": { "sellerId": { "type": "string", "description": "SKU seller ID.", "example": "1" }, "sellerName": { "type": "string", "description": "SKU seller name.", "example": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE" }, "addToCartLink": { "type": "string", "description": "URL to add the product to the cart.", "example": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1" }, "sellerDefault": { "type": "boolean", "description": "If the seller is default or not.", "example": true }, "commertialOffer": { "type": "object", "description": "AKA Commertial Condition.", "example": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } }, "required": [ "DeliverySlaSamplesPerRegion", "Installments", "DiscountHighLight", "GiftSkuIds", "Teasers", "BuyTogether", "ItemMetadataAttachment", "Price", "ListPrice", "PriceWithoutDiscount", "RewardValue", "PriceValidUntil", "AvailableQuantity", "IsAvailable", "Tax", "SaleChannel", "DeliverySlaSamples", "GetInfoErrorMessage", "CacheVersionUsedToCallCheckout", "PaymentOptions" ], "properties": { "DeliverySlaSamplesPerRegion": { "type": "object", "description": "Delivery SLA samples per region.", "example": { "0": { "DeliverySlaPerTypes": [], "Region": "null" } }, "properties": { "0": { "type": "object", "description": "Delivery SLA ID.", "example": { "DeliverySlaPerTypes": [], "Region": null }, "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "example": [] }, "Region": { "type": "string", "description": "Region.", "nullable": true, "example": "" } } } } }, "Installments": { "type": "array", "description": "Installments options.", "example": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" } ], "items": { "type": "object", "example": { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, "required": [ "Value", "InterestRate", "TotalValuePlusInterestRate", "NumberOfInstallments", "PaymentSystemName", "PaymentSystemGroupName", "Name" ], "properties": { "Value": { "type": "number", "description": "Value of the installment.", "example": 42.0 }, "InterestRate": { "type": "number", "description": "Interest rate of the installment.", "example": 0.0 }, "TotalValuePlusInterestRate": { "type": "number", "description": "Total value plus interest rate of the installment.", "example": 42.0 }, "NumberOfInstallments": { "type": "integer", "description": "Number of the installment.", "example": 1 }, "PaymentSystemName": { "type": "string", "description": "Payment system name of the installment.", "example": "Visa" }, "PaymentSystemGroupName": { "type": "string", "description": "Payment system group name of the installment.", "example": "creditCardPaymentGroup" }, "Name": { "type": "string", "description": "Name of the installment.", "example": "Visa à vista" } } } }, "DiscountHighLight": { "type": "array", "description": "Discount hightlight.", "example": [] }, "GiftSkuIds": { "type": "array", "description": "Array of SKU gifts IDs.", "example": [] }, "Teasers": { "type": "array", "description": "List with promotions teasers.", "example": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "items": { "type": "object", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}.", "properties": { "{field}": { "type": "string", "example": "{value}" } } }, "k__BackingField": { "type": "object", "description": "Conditions.", "properties": { "k__BackingField": { "type": "integer", "description": "Minimum quantity." }, "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } }, "k__BackingField": { "type": "object", "description": "Effects.", "properties": { "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } } } } }, "PromotionTeasers": { "type": "array", "description": "List with promotions teasers.", "example": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name." }, "GeneralValues": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}.", "properties": { "{field}": { "type": "string", "example": "{value}" } } }, "Conditions": { "type": "object", "description": "Conditions.", "properties": { "MinimumQuantity": { "type": "integer", "description": "Minimum quantity." }, "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } }, "Effects": { "type": "object", "description": "Effects.", "properties": { "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } } } } }, "BuyTogether": { "type": "array", "description": "Array of other products that can be bought together with the product in question.", "example": [] }, "ItemMetadataAttachment": { "type": "array", "description": "Item metadata attachment.", "example": [] }, "Price": { "type": "number", "description": "Price of the product.", "example": 42.0 }, "ListPrice": { "type": "number", "description": "List price of the product.", "example": 42.0 }, "PriceWithoutDiscount": { "type": "number", "description": "Price of the product without discount.", "example": 42.0 }, "RewardValue": { "type": "number", "description": "Reward value of the product.", "example": 0.0 }, "PriceValidUntil": { "type": "string", "description": "Price of the product valid until a certain date.", "example": "4000-01-01T03:00:00Z" }, "AvailableQuantity": { "type": "integer", "description": "Use the `IsAvailable` field instead.", "example": 16 }, "IsAvailable": { "type": "boolean", "description": "If the product is available or not.", "example": true }, "Tax": { "type": "number", "description": "Tax of the product.", "example": 0.0 }, "SaleChannel": { "type": "integer", "description": "Trade policy which the product is contained.", "example": 0 }, "DeliverySlaSamples": { "type": "array", "description": "Delivery SLA samples.", "example": [ { "DeliverySlaPerTypes": [], "Region": null } ], "items": { "type": "object", "example": { "DeliverySlaPerTypes": [], "Region": null }, "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "example": [] }, "Region": { "type": "string", "description": "Region.", "nullable": true, "example": null } } } }, "GetInfoErrorMessage": { "type": "string", "description": "Get info error message.", "nullable": true, "example": null }, "CacheVersionUsedToCallCheckout": { "type": "string", "description": "Cache version used to call checkout.", "example": "95EF7E5476DF276E679167A399FE3103_" }, "PaymentOptions": { "type": "object", "description": "Payment options.", "example": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] }, "required": [ "installmentOptions", "paymentSystems", "payments", "giftCards", "giftCardMessages", "availableAccounts", "availableTokens" ], "properties": { "installmentOptions": { "type": "array", "description": "installment options.", "example": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "items": { "type": "object", "example": { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, "required": [ "paymentSystem", "bin", "paymentName", "paymentGroupName", "value", "installments" ], "properties": { "paymentSystem": { "type": "string", "description": "Payment system.", "example": "2" }, "bin": { "type": "string", "description": "Bin.", "nullable": true, "example": null }, "paymentName": { "type": "string", "description": "Payment name.", "example": "Visa" }, "paymentGroupName": { "type": "string", "description": "Payment group name.", "example": "creditCardPaymentGroup" }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "installments": { "type": "array", "description": "Installments.", "example": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] } ], "items": { "type": "object", "example": { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, "required": [ "count", "hasInterestRate", "interestRate", "value", "total", "sellerMerchantInstallments" ], "properties": { "count": { "type": "integer", "description": "Count.", "example": 1 }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate.", "example": false }, "interestRate": { "type": "integer", "description": "Interest rate.", "example": 0 }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "total": { "type": "integer", "description": "Total.", "example": 4200 }, "sellerMerchantInstallments": { "type": "array", "description": "Seller merchant installments.", "example": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ], "items": { "type": "object", "example": { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 }, "required": [ "id", "count", "hasInterestRate", "interestRate", "value", "total" ], "properties": { "id": { "type": "string", "description": "ID.", "example": "MERCH" }, "count": { "type": "integer", "description": "Count.", "example": 1 }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate.", "example": false }, "interestRate": { "type": "integer", "description": "Interest rate.", "example": 0 }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "total": { "type": "integer", "description": "Total.", "example": 4200 } } } } } } } } } }, "paymentSystems": { "type": "array", "description": "Payment systems.", "example": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "items": { "type": "object", "example": { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, "required": [ "id", "name", "groupName", "validator", "stringId", "template", "requiresDocument", "isCustom", "description", "requiresAuthentication", "dueDate", "availablePayments" ], "properties": { "id": { "type": "integer", "description": "ID.", "example": 17 }, "name": { "type": "string", "description": "Name.", "example": "Promissory" }, "groupName": { "type": "string", "description": "Group name.", "example": "promissoryPaymentGroup" }, "validator": { "type": "string", "description": "Validator.", "nullable": true, "example": "" }, "stringId": { "type": "string", "description": "String ID.", "example": "17" }, "template": { "type": "string", "description": "Template.", "example": "promissoryPaymentGroup-template" }, "requiresDocument": { "type": "boolean", "description": "If requires document or not.", "example": false }, "isCustom": { "type": "boolean", "description": "If is custom or not.", "example": false }, "description": { "type": "string", "description": "Description.", "nullable": true, "example": "" }, "requiresAuthentication": { "type": "boolean", "description": "If requires authentication.", "example": false }, "dueDate": { "type": "string", "description": "Due date.", "example": "2021-07-01T18:43:00.0264384Z" }, "availablePayments": { "type": "string", "description": "Available payments.", "nullable": true, "example": "" } } } }, "payments": { "type": "array", "description": "Payments.", "example": [] }, "giftCards": { "type": "array", "description": "GiftCards.", "example": [] }, "giftCardMessages": { "type": "array", "description": "GiftCardMessages.", "example": [] }, "availableAccounts": { "type": "array", "description": "Available accounts.", "example": [] }, "availableTokens": { "type": "array", "description": "Available tokens.", "example": [] } } } } } } } }, "Videos": { "type": "array", "description": "Videos.", "example": [] }, "estimatedDateArrival": { "type": "string", "description": "Estimated date arrival.", "nullable": true, "example": "" } } } } } } } } } } }, "deprecated": true } }, "/api/catalog_system/pub/products/crossselling/showtogether/{productId}": { "get": { "tags": [ "CrossSelling" ], "summary": "Get product search of show together", "description": "Retrieves general information about the products that are show together with the product in question.", "operationId": "ProductSearchShowTogether", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "productId", "in": "path", "required": true, "description": "Product's unique identifier", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "OK" } }, "deprecated": false, "servers": [ { "url": "https://entelperu.{environment}.com.br/api/catalog_system/pub/products/crossselling/accessories", "variables": { "environment": { "default": "DefaultParameterValue" } } } ] } }, "/api/catalog_system/pub/products/crossselling/accessories/{productId}": { "get": { "tags": [ "CrossSelling" ], "summary": "Get product search of accessories", "description": "Retrieves general information about the product's accessories.", "operationId": "ProductSearchAccessories", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "productId", "in": "path", "required": true, "description": "Product's unique identifier", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "OK" } }, "deprecated": false, "servers": [ { "url": "https://entelperu.{environment}.com.br/api/catalog_system/pub/products/crossselling/accessories", "variables": { "environment": { "default": "DefaultParameterValue" } } } ] } }, "/api/catalog_system/pub/products/crossselling/similars/{productId}": { "get": { "tags": [ "CrossSelling" ], "summary": "Get product search of similars", "description": "Retrieves general information about related product searches.", "operationId": "ProductSearchSimilars", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "productId", "in": "path", "required": true, "description": "Product's unique identifier", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/catalog_system/pub/products/crossselling/suggestions/{productId}": { "get": { "tags": [ "CrossSelling" ], "summary": "Get product search of suggestions", "description": "Retrieves general information about other product suggestions related to the product.", "operationId": "ProductSearchSuggestions", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "productId", "in": "path", "required": true, "description": "Product's unique identifier", "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "OK" } } } }, "/api/catalog_system/pub/products/search/{search}": { "get": { "tags": [ "Search" ], "summary": "Search for products", "description": "Retrieves general information about the products related to the term searched. \r\nThis is the main search used by the store. The user can type anything to be searched. \r\n\r\nFor example, if they search for a \"decanter\", this is the URL: `https://{{accountName}}.{{environment}}.com.br/api/catalog_system/pub/products/search/decanter`. \r\n\r\nNote that maybe the response can be HTTP 200 or 206, 206 means that it's a partial content response.\r\n\r\nIf it is a 206 take a look at the Headers, will be an entry called resources. E.g.: resources → 0-9/19. This means that the response is showing items from 0 to 9, 10 items, but there were 19 items found. See more information at the paging route example.", "operationId": "ProductSearch", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "search", "in": "path", "description": "Term used to search products", "required": true, "style": "simple", "schema": { "type": "string", "example": "jacket" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "productId": "35", "productName": "Kit de Hoegaarden", "brand": "Hoegaarden", "brandId": 2000004, "brandImageUrl": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg", "linkText": "kit-6-cerveja-hoegaarden", "productReference": "000806", "productReferenceCode": null, "categoryId": "1", "productTitle": "", "metaTagDescription": "", "releaseDate": "2020-10-07T00:00:00", "clusterHighlights": { "138": "teste2" }, "productClusters": { "138": "teste2", "143": "NaoPesquisavel", "146": "colecaotestesubcategoria", "161": "merch_import_test1" }, "searchableClusters": { "138": "teste2" }, "categories": [ "/Beers Beers Mesmo/" ], "categoriesIds": [ "/1/" ], "link": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p", "Percentuals": [ "4,9" ], "Percentual": [ "4,9" ], "Total": [ "Percentuals", "Percentual" ], "Teste de Api": [ "a" ], "Ale": [ "1" ], "Teste da Api2": [ "Teste de Api", "Ale" ], "Alcool": [ "Percentual" ], "allSpecifications": [ "Percentuals", "Percentual", "Teste de Api", "Ale" ], "allSpecificationsGroups": [ "Total", "Teste da Api2" ], "description": "", "items": [ { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0000, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null } ] } ], "schema": { "type": "array", "items": { "type": "object", "required": [ "productId", "productName", "brand", "brandId", "brandImageUrl", "linkText", "productReference", "productReferenceCode", "categoryId", "productTitle", "metaTagDescription", "releaseDate", "clusterHighlights", "productClusters", "searchableClusters", "categories", "categoriesIds", "link", "Percentuals", "Percentual", "Total", "Teste de Api", "Ale", "Teste da Api2", "Alcool", "allSpecifications", "allSpecificationsGroups", "description", "items" ], "properties": { "productId": { "type": "string", "description": "Product unique identifier.", "example": "35" }, "productName": { "type": "string", "description": "Product name.", "example": "Kit de Hoegaarden" }, "brand": { "type": "string", "description": "Brand name.", "example": "Hoegaarden" }, "brandId": { "type": "integer", "description": "Product brand ID.", "example": 2000004 }, "brandImageUrl": { "type": "string", "description": "Product's brand image URL.", "example": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg" }, "linkText": { "type": "string", "description": "Product URL.", "example": "kit-6-cerveja-hoegaarden" }, "productReference": { "type": "string", "description": "Product reference.", "example": "000806" }, "productReferenceCode": { "type": "integer", "description": "Product reference ID.", "nullable": true, "example": 1234 }, "categoryId": { "type": "string", "description": "Product category ID.", "example": "1" }, "productTitle": { "type": "string", "description": "Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO.", "example": "Kit 6 cerveja Hoegaarden" }, "metaTagDescription": { "type": "string", "description": "Brief description of the category. It's recommended that you don't exceed 150 characters so that the search engines can display it correctly in the results page.", "example": "Category for Beers" }, "releaseDate": { "type": "string", "description": "Product release date.", "example": "2020-10-07T00:00:00" }, "clusterHighlights": { "type": "object", "description": "Cluster highlight ID and name.", "example": { "138": "teste2" } }, "productClusters": { "type": "object", "description": "Product clusters' IDs and names.", "example": { "138": "teste2", "143": "NaoPesquisavel", "146": "colecaotestesubcategoria", "161": "merch_import_test1" } }, "searchableClusters": { "type": "object", "description": "Searchable clusters IDs and names.", "example": { "138": "teste2" } }, "categories": { "type": "array", "description": "Array of the product's categories URLs.", "example": [ "/Beers Beers Mesmo/" ] }, "categoriesIds": { "type": "array", "description": "Array of the product's categories IDs.", "example": [ "/1/" ] }, "link": { "type": "string", "description": "Product URL.", "example": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p" }, "allSpecifications": { "type": "array", "description": "Array of the product's specifications.", "example": [ "Percentuals", "Percentual" ], "items": { "type": "string", "description": "Product specification.", "example": "Percentual" } }, "allSpecificationsGroups": { "type": "array", "description": "Array of the product's specifications groups.", "example": [ "Total", "Teste da Api2" ], "items": { "type": "string", "description": "Product specification group.", "example": "Teste da Api2" } }, "description": { "type": "string", "description": "Description of the main information related to the product. A simple and easy to understand summary for the customer.", "example": "Description example", "nullable": true }, "items": { "type": "array", "description": "Array containing the product SKU general information.", "example": [ { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null } ], "items": { "type": "object", "example": { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null }, "required": [ "itemId", "name", "nameComplete", "complementName", "ean", "referenceId", "measurementUnit", "unitMultiplier", "modalType", "isKit", "kitItems", "images", "sellers", "Videos", "estimatedDateArrival" ], "properties": { "itemId": { "type": "string", "description": "SKU ID.", "example": "310118469" }, "name": { "type": "string", "description": "SKU name.", "example": "Kit com 6" }, "nameComplete": { "type": "string", "description": "SKU complete name.", "example": "Kit de Hoegaarden Kit com 6" }, "complementName": { "type": "string", "description": "SKU complement name.", "example": "Complement name" }, "ean": { "type": "string", "description": "SKU unique identification code (barcode), accepts up to 13 numerical characters.", "example": "12345567" }, "referenceId": { "type": "array", "description": "Reference code ID.", "example": [ { "Key": "RefId", "Value": "000806" } ], "items": { "type": "object", "example": { "Key": "RefId", "Value": "000806" }, "required": [ "Key", "Value" ], "properties": { "Key": { "type": "string", "description": "Reference Code.", "example": "RefId" }, "Value": { "type": "string", "description": "Unique reference code used internally for organizational purposes.", "example": "000806" } } } }, "measurementUnit": { "type": "string", "description": "Used only in cases when you need to convert the unit of measure for sale. In common cases, use 'un'.", "example": "un" }, "unitMultiplier": { "type": "number", "description": "numerical unit that multiplies the selected quantity of the product when it is inserted in the cart.", "example": 1.0 }, "modalType": { "type": "string", "description": "Modal Type.", "nullable": true, "example": "Modal Type test" }, "isKit": { "type": "boolean", "description": "If the SKU is part of a kit.", "example": true }, "kitItems": { "type": "array", "description": "Array with information of SKUs components from a Kit.", "example": [ { "itemId": "310118466", "amount": 6 } ], "items": { "type": "object", "example": { "itemId": "310118466", "amount": 6 }, "required": [ "itemId", "amount" ], "properties": { "itemId": { "type": "string", "description": "SKU kit component ID.", "example": "310118466" }, "amount": { "type": "integer", "description": "Amount of the SKU component in the kit.", "example": 6 } } } }, "images": { "type": "array", "description": "Array of information about the SKU image.", "example": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "items": { "type": "object", "example": { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" }, "required": [ "imageId", "imageLabel", "imageTag", "imageUrl", "imageText", "imageLastModified" ], "properties": { "imageId": { "type": "string", "description": "Image ID.", "example": "155489" }, "imageLabel": { "type": "string", "description": "Image label.", "example": "Label test" }, "imageTag": { "type": "string", "description": "Image tag.", "example": "\"hoegaarden-kit\"" }, "imageUrl": { "type": "string", "description": "Image URL.", "example": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000" }, "imageText": { "type": "string", "description": "Image text.", "nullable": true, "example": "hoegaarden-kit" }, "imageLastModified": { "type": "string", "description": "Date and time of the last update of the image.", "example": "2020-10-07T12:49:27.5800000Z" } } } }, "sellers": { "type": "array", "description": "Array of SKU sellers.", "example": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "items": { "type": "object", "example": { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } }, "required": [ "sellerId", "sellerName", "addToCartLink", "sellerDefault", "commertialOffer" ], "properties": { "sellerId": { "type": "string", "description": "SKU seller ID.", "example": "1" }, "sellerName": { "type": "string", "description": "SKU seller name.", "example": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE" }, "addToCartLink": { "type": "string", "description": "URL to add the product to the cart.", "example": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1" }, "sellerDefault": { "type": "boolean", "description": "If the seller is default or not.", "example": true }, "commertialOffer": { "type": "object", "description": "AKA Commertial Condition.", "example": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } }, "required": [ "DeliverySlaSamplesPerRegion", "Installments", "DiscountHighLight", "GiftSkuIds", "Teasers", "BuyTogether", "ItemMetadataAttachment", "Price", "ListPrice", "PriceWithoutDiscount", "RewardValue", "PriceValidUntil", "AvailableQuantity", "IsAvailable", "Tax", "SaleChannel", "DeliverySlaSamples", "GetInfoErrorMessage", "CacheVersionUsedToCallCheckout", "PaymentOptions" ], "properties": { "DeliverySlaSamplesPerRegion": { "type": "object", "description": "Delivery SLA samples per region.", "example": { "0": { "DeliverySlaPerTypes": [], "Region": "null" } }, "properties": { "0": { "type": "object", "description": "Delivery SLA ID.", "example": { "DeliverySlaPerTypes": [], "Region": null }, "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "example": [] }, "Region": { "type": "string", "description": "Region.", "nullable": true, "example": "" } } } } }, "Installments": { "type": "array", "description": "Installments options.", "example": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" } ], "items": { "type": "object", "example": { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, "required": [ "Value", "InterestRate", "TotalValuePlusInterestRate", "NumberOfInstallments", "PaymentSystemName", "PaymentSystemGroupName", "Name" ], "properties": { "Value": { "type": "number", "description": "Value of the installment.", "example": 42.0 }, "InterestRate": { "type": "number", "description": "Interest rate of the installment.", "example": 0.0 }, "TotalValuePlusInterestRate": { "type": "number", "description": "Total value plus interest rate of the installment.", "example": 42.0 }, "NumberOfInstallments": { "type": "integer", "description": "Number of the installment.", "example": 1 }, "PaymentSystemName": { "type": "string", "description": "Payment system name of the installment.", "example": "Visa" }, "PaymentSystemGroupName": { "type": "string", "description": "Payment system group name of the installment.", "example": "creditCardPaymentGroup" }, "Name": { "type": "string", "description": "Name of the installment.", "example": "Visa à vista" } } } }, "DiscountHighLight": { "type": "array", "description": "Discount hightlight.", "example": [] }, "GiftSkuIds": { "type": "array", "description": "Array of SKU gifts IDs.", "example": [] }, "Teasers": { "type": "array", "description": "List with promotions teasers.", "example": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "items": { "type": "object", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}.", "properties": { "{field}": { "type": "string", "example": "{value}" } } }, "k__BackingField": { "type": "object", "description": "Conditions.", "properties": { "k__BackingField": { "type": "integer", "description": "Minimum quantity." }, "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } }, "k__BackingField": { "type": "object", "description": "Effects.", "properties": { "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } } } } }, "PromotionTeasers": { "type": "array", "description": "List with promotions teasers.", "example": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name." }, "GeneralValues": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}.", "properties": { "{field}": { "type": "string", "example": "{value}" } } }, "Conditions": { "type": "object", "description": "Conditions.", "properties": { "MinimumQuantity": { "type": "integer", "description": "Minimum quantity." }, "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } }, "Effects": { "type": "object", "description": "Effects.", "properties": { "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } } } } }, "BuyTogether": { "type": "array", "description": "Array of other products that can be bought together with the product in question.", "example": [] }, "ItemMetadataAttachment": { "type": "array", "description": "Item metadata attachment.", "example": [] }, "Price": { "type": "number", "description": "Price of the product.", "example": 42.0 }, "ListPrice": { "type": "number", "description": "List price of the product.", "example": 42.0 }, "PriceWithoutDiscount": { "type": "number", "description": "Price of the product without discount.", "example": 42.0 }, "RewardValue": { "type": "number", "description": "Reward value of the product.", "example": 0.0 }, "PriceValidUntil": { "type": "string", "description": "Price of the product valid until a certain date.", "example": "4000-01-01T03:00:00Z" }, "AvailableQuantity": { "type": "integer", "description": "Use the `IsAvailable` field instead.", "example": 16 }, "IsAvailable": { "type": "boolean", "description": "If the product is available or not.", "example": true }, "Tax": { "type": "number", "description": "Tax of the product.", "example": 0.0 }, "SaleChannel": { "type": "integer", "description": "Trade policy which the product is contained.", "example": 0 }, "DeliverySlaSamples": { "type": "array", "description": "Delivery SLA samples.", "example": [ { "DeliverySlaPerTypes": [], "Region": null } ], "items": { "type": "object", "example": { "DeliverySlaPerTypes": [], "Region": null }, "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "example": [] }, "Region": { "type": "string", "description": "Region.", "nullable": true, "example": null } } } }, "GetInfoErrorMessage": { "type": "string", "description": "Get info error message.", "nullable": true, "example": null }, "CacheVersionUsedToCallCheckout": { "type": "string", "description": "Cache version used to call checkout.", "example": "95EF7E5476DF276E679167A399FE3103_" }, "PaymentOptions": { "type": "object", "description": "Payment options.", "example": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] }, "required": [ "installmentOptions", "paymentSystems", "payments", "giftCards", "giftCardMessages", "availableAccounts", "availableTokens" ], "properties": { "installmentOptions": { "type": "array", "description": "installment options.", "example": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "items": { "type": "object", "example": { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, "required": [ "paymentSystem", "bin", "paymentName", "paymentGroupName", "value", "installments" ], "properties": { "paymentSystem": { "type": "string", "description": "Payment system.", "example": "2" }, "bin": { "type": "string", "description": "Bin.", "nullable": true, "example": null }, "paymentName": { "type": "string", "description": "Payment name.", "example": "Visa" }, "paymentGroupName": { "type": "string", "description": "Payment group name.", "example": "creditCardPaymentGroup" }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "installments": { "type": "array", "description": "Installments.", "example": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] } ], "items": { "type": "object", "example": { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, "required": [ "count", "hasInterestRate", "interestRate", "value", "total", "sellerMerchantInstallments" ], "properties": { "count": { "type": "integer", "description": "Count.", "example": 1 }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate.", "example": false }, "interestRate": { "type": "integer", "description": "Interest rate.", "example": 0 }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "total": { "type": "integer", "description": "Total.", "example": 4200 }, "sellerMerchantInstallments": { "type": "array", "description": "Seller merchant installments.", "example": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ], "items": { "type": "object", "example": { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 }, "required": [ "id", "count", "hasInterestRate", "interestRate", "value", "total" ], "properties": { "id": { "type": "string", "description": "ID.", "example": "MERCH" }, "count": { "type": "integer", "description": "Count.", "example": 1 }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate.", "example": false }, "interestRate": { "type": "integer", "description": "Interest rate.", "example": 0 }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "total": { "type": "integer", "description": "Total.", "example": 4200 } } } } } } } } } }, "paymentSystems": { "type": "array", "description": "Payment systems.", "example": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "items": { "type": "object", "example": { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, "required": [ "id", "name", "groupName", "validator", "stringId", "template", "requiresDocument", "isCustom", "description", "requiresAuthentication", "dueDate", "availablePayments" ], "properties": { "id": { "type": "integer", "description": "ID.", "example": 17 }, "name": { "type": "string", "description": "Name.", "example": "Promissory" }, "groupName": { "type": "string", "description": "Group name.", "example": "promissoryPaymentGroup" }, "validator": { "type": "string", "description": "Validator.", "nullable": true, "example": "" }, "stringId": { "type": "string", "description": "String ID.", "example": "17" }, "template": { "type": "string", "description": "Template.", "example": "promissoryPaymentGroup-template" }, "requiresDocument": { "type": "boolean", "description": "If requires document or not.", "example": false }, "isCustom": { "type": "boolean", "description": "If is custom or not.", "example": false }, "description": { "type": "string", "description": "Description.", "nullable": true, "example": "" }, "requiresAuthentication": { "type": "boolean", "description": "If requires authentication.", "example": false }, "dueDate": { "type": "string", "description": "Due date.", "example": "2021-07-01T18:43:00.0264384Z" }, "availablePayments": { "type": "string", "description": "Available payments.", "nullable": true, "example": "" } } } }, "payments": { "type": "array", "description": "Payments.", "example": [] }, "giftCards": { "type": "array", "description": "GiftCards.", "example": [] }, "giftCardMessages": { "type": "array", "description": "GiftCardMessages.", "example": [] }, "availableAccounts": { "type": "array", "description": "Available accounts.", "example": [] }, "availableTokens": { "type": "array", "description": "Available tokens.", "example": [] } } } } } } } }, "Videos": { "type": "array", "description": "Videos.", "example": [] }, "estimatedDateArrival": { "type": "string", "description": "Estimated date arrival.", "nullable": true, "example": "" } } } } } } } } } } } } }, "/api/catalog_system/pub/products/search": { "get": { "tags": [ "Search" ], "summary": "Search for products with filter, order and pagination", "description": "Retrieves general information about the store's products. This information can be filtered and ordered by a number of options. It also can be paginated, filtered and ordered. \r\n\r\n## Filters \r\n\r\n- **Filter by full text** - `ft={searchWord}` \r\nE.g.: `ft=television`\r\n\r\n- **Filter by category** - `fq=C:/{a}/{b}` \r\n`{a}` and `{b}` are Category IDs \r\nE.g.: `fq=C:/1000041/1000049/`\r\n\r\n- **Filter by brand** - `fq=B:/{a}/{b}` \r\n`{a}` and `{b}` are Brand IDs\r\nE.g.: `fq=B:/189385/189387/`\r\n\r\n- **Filter by specification** - `fq=specificationFilter_{a}:{b}` \r\n`{a}` is the specification ID\r\n`{b}` is the specification value\r\nE.g.: To filter products where the color is Blue, find the specification ID for color. Suppose it is 123, then the query will be: `fq=specificationFilter_123:Blue`\r\n\r\n- **Filter by price range** - `fq=P:[{a} TO {b}]` \r\n`{a}` is the minimum price \"from\"\r\n`{b}` is the highest price \"to\" \r\nE.g.: `fq=P:[0 TO 20]` will search products between 0.00 and 20.00. \r\n\r\n- **Filter by collection** - `fq=productClusterIds:{{productClusterId}}` \r\n`productClusterId` is the same as `collectionId` \r\nFor more information about collections, read [Creating a product collection](https://help.vtex.com/en/tutorial/creating-a-product-collection).\r\n\r\n- **Filter by product ID** - `fq=productId:{{productId}}`\r\n\r\n- **Filter by SKU ID** - `fq=skuId:{{skuId}}`\r\n\r\n- **Filter by referenceId** - `fq=alternateIds_RefId:{{referenceId}}`\r\n\r\n- **Filter by EAN13** - `fq=alternateIds_Ean:{{ean13}}`\r\n\r\n- **Filter by availability at a specific sales channel** - `fq=isAvailablePerSalesChannel_{{sc}}:{{bool}}` \r\n`{{sc}}` is the desired sales channel \r\n`{{bool}}` is true ou false, 1 or 0. \r\nE.g.: seaching available products for the sales channel 4 would be `fq=isAvailablePerSalesChannel_4:1`\r\n\r\n- **Filter by available at a specific seller** - `fq=sellerId:{{sellerId}}`\r\nThe search does not include White Label Sellers.\r\n\r\n## Pagination\r\n\r\n- **Initial item number** - `_from={{first}}`\r\n- **Final item number** - `_to={{last}}`\r\n\r\n>⚠️ This endpoint returns a maximum of 50 items per response, so the difference between `_from` and `_to` should not exceed this number. The result order is descending, from the highest product ID to the lowest.\r\n\r\n## Sorting\r\n\r\n- **Price** \r\n`O=OrderByPriceDESC` \r\n`O=OrderByPriceASC`\r\n\r\n- **Top Selling Products** \r\n`O=OrderByTopSaleDESC`\r\n\r\n- **Best Reviews** \r\n`O=OrderByReviewRateDESC`\r\n\r\n- **Name** \r\n`O=OrderByNameASC` \r\n`O=OrderByNameDESC`\r\n\r\n- **Release Date** \r\n`O=OrderByReleaseDateDESC`\r\n\r\n- **Best Discounts** \r\n`O=OrderByBestDiscountDESC`\r\n\r\n- **Score** \r\n`O=OrderByScoreDESC`", "operationId": "ProductSearchFilteredandOrdered", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "_from", "in": "query", "description": "Starting page of the pagination range. This number must be below or equal to 2500 for the query to work. Note that the difference between the initial and final pages cannot exceed 50 pages. Therefore, each page will display a maximum of 50 items.", "required": false, "style": "form", "schema": { "type": "string", "example": "1" } }, { "name": "_to", "in": "query", "description": "Final page of the pagination range. Note that the difference between the initial and final pages cannot exceed 50 pages. Therefore, each page will display a maximum of 50 items.", "required": false, "style": "form", "schema": { "type": "string", "example": "50" } }, { "name": "ft", "in": "query", "description": "Filter by full text. The form is`ft={searchWord}`.", "required": false, "style": "form", "schema": { "type": "string", "example": "television" } }, { "name": "fq", "in": "query", "description": "General filter. It can be by category (`fq=C:{a}/{b}`), by specification (`fq=specificationFilter_{a}:{b}`), by price range (`fq=P:[{a} TO {b}]`), by collection (`fq=productClusterIds:{{productClusterId}}`), by product ID (`fq=productId:{{productId}}`), by SKU ID (`fq=skuId:{{skuId}}`), by Reference ID (`fq=alternateIds_RefId:{{referenceId}}`), by EAN13 (`fq=alternateIds_Ean:{{ean13}}`), by availability at a specific sales channel (`fq=isAvailablePerSalesChannel_{{sc}}:{{bool}}`), by available at a specific seller (`fq=sellerId:{{sellerId}}`).", "required": false, "style": "form", "schema": { "type": "string", "example": "C:/1000041/1000049/" } }, { "name": "O", "in": "query", "description": "Sorting method. It can be by Price (`O=OrderByPriceDESC` or `O=OrderByPriceASC`), by Top Selling Products (`O=OrderByTopSaleDESC`), by Best Reviews (`O=OrderByReviewRateDESC`), by Name (`O=OrderByNameASC` or `O=OrderByNameDESC`), by Release Date (`O=OrderByReleaseDateDESC`), by Best Discounts (`O=OrderByBestDiscountDESC`), by Score (`O=OrderByScoreDESC`).", "required": false, "style": "form", "schema": { "type": "string", "example": "OrderByNameASC" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "productId": "35", "productName": "Kit de Hoegaarden", "brand": "Hoegaarden", "brandId": 2000004, "brandImageUrl": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg", "linkText": "kit-6-cerveja-hoegaarden", "productReference": "000806", "productReferenceCode": null, "categoryId": "1", "productTitle": "", "metaTagDescription": "", "releaseDate": "2020-10-07T00:00:00", "clusterHighlights": { "138": "teste2" }, "productClusters": { "138": "teste2", "143": "NaoPesquisavel", "146": "colecaotestesubcategoria", "161": "merch_import_test1" }, "searchableClusters": { "138": "teste2" }, "categories": [ "/Beers Beers Mesmo/" ], "categoriesIds": [ "/1/" ], "link": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p", "Percentuals": [ "4,9" ], "Percentual": [ "4,9" ], "Total": [ "Percentuals", "Percentual" ], "Teste de Api": [ "a" ], "Ale": [ "1" ], "Teste da Api2": [ "Teste de Api", "Ale" ], "Alcool": [ "Percentual" ], "allSpecifications": [ "Percentuals", "Percentual", "Teste de Api", "Ale" ], "allSpecificationsGroups": [ "Total", "Teste da Api2" ], "description": "", "items": [ { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0000, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null } ] } ], "schema": { "type": "array", "items": { "type": "object", "required": [ "productId", "productName", "brand", "brandId", "brandImageUrl", "linkText", "productReference", "productReferenceCode", "categoryId", "productTitle", "metaTagDescription", "releaseDate", "clusterHighlights", "productClusters", "searchableClusters", "categories", "categoriesIds", "link", "Percentuals", "Percentual", "Total", "Teste de Api", "Ale", "Teste da Api2", "Alcool", "allSpecifications", "allSpecificationsGroups", "description", "items" ], "properties": { "productId": { "type": "string", "description": "Product unique identifier.", "example": "35" }, "productName": { "type": "string", "description": "Product name.", "example": "Kit de Hoegaarden" }, "brand": { "type": "string", "description": "Brand name.", "example": "Hoegaarden" }, "brandId": { "type": "integer", "description": "Product brand ID.", "example": 2000004 }, "brandImageUrl": { "type": "string", "description": "Product's brand image URL.", "example": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg" }, "linkText": { "type": "string", "description": "Product URL.", "example": "kit-6-cerveja-hoegaarden" }, "productReference": { "type": "string", "description": "Product reference.", "example": "000806" }, "productReferenceCode": { "type": "integer", "description": "Product reference ID.", "nullable": true, "example": 1234 }, "categoryId": { "type": "string", "description": "Product category ID.", "example": "1" }, "productTitle": { "type": "string", "description": "Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO.", "example": "Kit 6 cerveja Hoegaarden" }, "metaTagDescription": { "type": "string", "description": "Brief description of the category. It's recommended that you don't exceed 150 characters so that the search engines can display it correctly in the results page.", "example": "Category for Beers" }, "releaseDate": { "type": "string", "description": "Product release date.", "example": "2020-10-07T00:00:00" }, "clusterHighlights": { "type": "object", "description": "Cluster highlight ID and name.", "example": { "138": "teste2" } }, "productClusters": { "type": "object", "description": "Product clusters' IDs and names.", "example": { "138": "teste2", "143": "NaoPesquisavel", "146": "colecaotestesubcategoria", "161": "merch_import_test1" } }, "searchableClusters": { "type": "object", "description": "Searchable clusters IDs and names.", "example": { "138": "teste2" } }, "categories": { "type": "array", "description": "Array of the product's categories URLs.", "example": [ "/Beers Beers Mesmo/" ] }, "categoriesIds": { "type": "array", "description": "Array of the product's categories IDs.", "example": [ "/1/" ] }, "link": { "type": "string", "description": "Product URL.", "example": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p" }, "allSpecifications": { "type": "array", "description": "Array of the product's specifications.", "example": [ "Percentuals", "Percentual" ], "items": { "type": "string", "description": "Product specification.", "example": "Percentual" } }, "allSpecificationsGroups": { "type": "array", "description": "Array of the product's specifications groups.", "example": [ "Total", "Teste da Api2" ], "items": { "type": "string", "description": "Product specification group.", "example": "Teste da Api2" } }, "description": { "type": "string", "description": "Description of the main information related to the product. A simple and easy to understand summary for the customer.", "example": "Description example", "nullable": true }, "items": { "type": "array", "description": "Array containing the product SKU general information.", "example": [ { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null } ], "items": { "type": "object", "example": { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null }, "required": [ "itemId", "name", "nameComplete", "complementName", "ean", "referenceId", "measurementUnit", "unitMultiplier", "modalType", "isKit", "kitItems", "images", "sellers", "Videos", "estimatedDateArrival" ], "properties": { "itemId": { "type": "string", "description": "SKU ID.", "example": "310118469" }, "name": { "type": "string", "description": "SKU name.", "example": "Kit com 6" }, "nameComplete": { "type": "string", "description": "SKU complete name.", "example": "Kit de Hoegaarden Kit com 6" }, "complementName": { "type": "string", "description": "SKU complement name.", "example": "Complement name" }, "ean": { "type": "string", "description": "SKU unique identification code (barcode), accepts up to 13 numerical characters.", "example": "12345567" }, "referenceId": { "type": "array", "description": "Reference code ID.", "example": [ { "Key": "RefId", "Value": "000806" } ], "items": { "type": "object", "example": { "Key": "RefId", "Value": "000806" }, "required": [ "Key", "Value" ], "properties": { "Key": { "type": "string", "description": "Reference Code.", "example": "RefId" }, "Value": { "type": "string", "description": "Unique reference code used internally for organizational purposes.", "example": "000806" } } } }, "measurementUnit": { "type": "string", "description": "Used only in cases when you need to convert the unit of measure for sale. In common cases, use 'un'.", "example": "un" }, "unitMultiplier": { "type": "number", "description": "numerical unit that multiplies the selected quantity of the product when it is inserted in the cart.", "example": 1.0 }, "modalType": { "type": "string", "description": "Modal Type.", "nullable": true, "example": "Modal Type test" }, "isKit": { "type": "boolean", "description": "If the SKU is part of a kit.", "example": true }, "kitItems": { "type": "array", "description": "Array with information of SKUs components from a Kit.", "example": [ { "itemId": "310118466", "amount": 6 } ], "items": { "type": "object", "example": { "itemId": "310118466", "amount": 6 }, "required": [ "itemId", "amount" ], "properties": { "itemId": { "type": "string", "description": "SKU kit component ID.", "example": "310118466" }, "amount": { "type": "integer", "description": "Amount of the SKU component in the kit.", "example": 6 } } } }, "images": { "type": "array", "description": "Array of information about the SKU image.", "example": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "items": { "type": "object", "example": { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" }, "required": [ "imageId", "imageLabel", "imageTag", "imageUrl", "imageText", "imageLastModified" ], "properties": { "imageId": { "type": "string", "description": "Image ID.", "example": "155489" }, "imageLabel": { "type": "string", "description": "Image label.", "example": "Label test" }, "imageTag": { "type": "string", "description": "Image tag.", "example": "\"hoegaarden-kit\"" }, "imageUrl": { "type": "string", "description": "Image URL.", "example": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000" }, "imageText": { "type": "string", "description": "Image text.", "nullable": true, "example": "hoegaarden-kit" }, "imageLastModified": { "type": "string", "description": "Date and time of the last update of the image.", "example": "2020-10-07T12:49:27.5800000Z" } } } }, "sellers": { "type": "array", "description": "Array of SKU sellers.", "example": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "items": { "type": "object", "example": { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } }, "required": [ "sellerId", "sellerName", "addToCartLink", "sellerDefault", "commertialOffer" ], "properties": { "sellerId": { "type": "string", "description": "SKU seller ID.", "example": "1" }, "sellerName": { "type": "string", "description": "SKU seller name.", "example": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE" }, "addToCartLink": { "type": "string", "description": "URL to add the product to the cart.", "example": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1" }, "sellerDefault": { "type": "boolean", "description": "If the seller is default or not.", "example": true }, "commertialOffer": { "type": "object", "description": "AKA Commertial Condition.", "example": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } }, "required": [ "DeliverySlaSamplesPerRegion", "Installments", "DiscountHighLight", "GiftSkuIds", "Teasers", "BuyTogether", "ItemMetadataAttachment", "Price", "ListPrice", "PriceWithoutDiscount", "RewardValue", "PriceValidUntil", "AvailableQuantity", "IsAvailable", "Tax", "SaleChannel", "DeliverySlaSamples", "GetInfoErrorMessage", "CacheVersionUsedToCallCheckout", "PaymentOptions" ], "properties": { "DeliverySlaSamplesPerRegion": { "type": "object", "description": "Delivery SLA samples per region.", "example": { "0": { "DeliverySlaPerTypes": [], "Region": "null" } }, "properties": { "0": { "type": "object", "description": "Delivery SLA ID.", "example": { "DeliverySlaPerTypes": [], "Region": null }, "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "example": [] }, "Region": { "type": "string", "description": "Region.", "nullable": true, "example": "" } } } } }, "Installments": { "type": "array", "description": "Installments options.", "example": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" } ], "items": { "type": "object", "example": { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, "required": [ "Value", "InterestRate", "TotalValuePlusInterestRate", "NumberOfInstallments", "PaymentSystemName", "PaymentSystemGroupName", "Name" ], "properties": { "Value": { "type": "number", "description": "Value of the installment.", "example": 42.0 }, "InterestRate": { "type": "number", "description": "Interest rate of the installment.", "example": 0.0 }, "TotalValuePlusInterestRate": { "type": "number", "description": "Total value plus interest rate of the installment.", "example": 42.0 }, "NumberOfInstallments": { "type": "integer", "description": "Number of the installment.", "example": 1 }, "PaymentSystemName": { "type": "string", "description": "Payment system name of the installment.", "example": "Visa" }, "PaymentSystemGroupName": { "type": "string", "description": "Payment system group name of the installment.", "example": "creditCardPaymentGroup" }, "Name": { "type": "string", "description": "Name of the installment.", "example": "Visa à vista" } } } }, "DiscountHighLight": { "type": "array", "description": "Discount hightlight.", "example": [] }, "GiftSkuIds": { "type": "array", "description": "Array of SKU gifts IDs.", "example": [] }, "Teasers": { "type": "array", "description": "List with promotions teasers.", "example": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "items": { "type": "object", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}.", "properties": { "{field}": { "type": "string", "example": "{value}" } } }, "k__BackingField": { "type": "object", "description": "Conditions.", "properties": { "k__BackingField": { "type": "integer", "description": "Minimum quantity." }, "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } }, "k__BackingField": { "type": "object", "description": "Effects.", "properties": { "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } } } } }, "PromotionTeasers": { "type": "array", "description": "List with promotions teasers.", "example": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name." }, "GeneralValues": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}.", "properties": { "{field}": { "type": "string", "example": "{value}" } } }, "Conditions": { "type": "object", "description": "Conditions.", "properties": { "MinimumQuantity": { "type": "integer", "description": "Minimum quantity." }, "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } }, "Effects": { "type": "object", "description": "Effects.", "properties": { "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } } } } }, "BuyTogether": { "type": "array", "description": "Array of other products that can be bought together with the product in question.", "example": [] }, "ItemMetadataAttachment": { "type": "array", "description": "Item metadata attachment.", "example": [] }, "Price": { "type": "number", "description": "Price of the product.", "example": 42.0 }, "ListPrice": { "type": "number", "description": "List price of the product.", "example": 42.0 }, "PriceWithoutDiscount": { "type": "number", "description": "Price of the product without discount.", "example": 42.0 }, "RewardValue": { "type": "number", "description": "Reward value of the product.", "example": 0.0 }, "PriceValidUntil": { "type": "string", "description": "Price of the product valid until a certain date.", "example": "4000-01-01T03:00:00Z" }, "AvailableQuantity": { "type": "integer", "description": "Use the `IsAvailable` field instead.", "example": 16 }, "IsAvailable": { "type": "boolean", "description": "If the product is available or not.", "example": true }, "Tax": { "type": "number", "description": "Tax of the product.", "example": 0.0 }, "SaleChannel": { "type": "integer", "description": "Trade policy which the product is contained.", "example": 0 }, "DeliverySlaSamples": { "type": "array", "description": "Delivery SLA samples.", "example": [ { "DeliverySlaPerTypes": [], "Region": null } ], "items": { "type": "object", "example": { "DeliverySlaPerTypes": [], "Region": null }, "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "example": [] }, "Region": { "type": "string", "description": "Region.", "nullable": true, "example": null } } } }, "GetInfoErrorMessage": { "type": "string", "description": "Get info error message.", "nullable": true, "example": null }, "CacheVersionUsedToCallCheckout": { "type": "string", "description": "Cache version used to call checkout.", "example": "95EF7E5476DF276E679167A399FE3103_" }, "PaymentOptions": { "type": "object", "description": "Payment options.", "example": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] }, "required": [ "installmentOptions", "paymentSystems", "payments", "giftCards", "giftCardMessages", "availableAccounts", "availableTokens" ], "properties": { "installmentOptions": { "type": "array", "description": "installment options.", "example": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "items": { "type": "object", "example": { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, "required": [ "paymentSystem", "bin", "paymentName", "paymentGroupName", "value", "installments" ], "properties": { "paymentSystem": { "type": "string", "description": "Payment system.", "example": "2" }, "bin": { "type": "string", "description": "Bin.", "nullable": true, "example": null }, "paymentName": { "type": "string", "description": "Payment name.", "example": "Visa" }, "paymentGroupName": { "type": "string", "description": "Payment group name.", "example": "creditCardPaymentGroup" }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "installments": { "type": "array", "description": "Installments.", "example": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] } ], "items": { "type": "object", "example": { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, "required": [ "count", "hasInterestRate", "interestRate", "value", "total", "sellerMerchantInstallments" ], "properties": { "count": { "type": "integer", "description": "Count.", "example": 1 }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate.", "example": false }, "interestRate": { "type": "integer", "description": "Interest rate.", "example": 0 }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "total": { "type": "integer", "description": "Total.", "example": 4200 }, "sellerMerchantInstallments": { "type": "array", "description": "Seller merchant installments.", "example": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ], "items": { "type": "object", "example": { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 }, "required": [ "id", "count", "hasInterestRate", "interestRate", "value", "total" ], "properties": { "id": { "type": "string", "description": "ID.", "example": "MERCH" }, "count": { "type": "integer", "description": "Count.", "example": 1 }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate.", "example": false }, "interestRate": { "type": "integer", "description": "Interest rate.", "example": 0 }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "total": { "type": "integer", "description": "Total.", "example": 4200 } } } } } } } } } }, "paymentSystems": { "type": "array", "description": "Payment systems.", "example": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "items": { "type": "object", "example": { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, "required": [ "id", "name", "groupName", "validator", "stringId", "template", "requiresDocument", "isCustom", "description", "requiresAuthentication", "dueDate", "availablePayments" ], "properties": { "id": { "type": "integer", "description": "ID.", "example": 17 }, "name": { "type": "string", "description": "Name.", "example": "Promissory" }, "groupName": { "type": "string", "description": "Group name.", "example": "promissoryPaymentGroup" }, "validator": { "type": "string", "description": "Validator.", "nullable": true, "example": "" }, "stringId": { "type": "string", "description": "String ID.", "example": "17" }, "template": { "type": "string", "description": "Template.", "example": "promissoryPaymentGroup-template" }, "requiresDocument": { "type": "boolean", "description": "If requires document or not.", "example": false }, "isCustom": { "type": "boolean", "description": "If is custom or not.", "example": false }, "description": { "type": "string", "description": "Description.", "nullable": true, "example": "" }, "requiresAuthentication": { "type": "boolean", "description": "If requires authentication.", "example": false }, "dueDate": { "type": "string", "description": "Due date.", "example": "2021-07-01T18:43:00.0264384Z" }, "availablePayments": { "type": "string", "description": "Available payments.", "nullable": true, "example": "" } } } }, "payments": { "type": "array", "description": "Payments.", "example": [] }, "giftCards": { "type": "array", "description": "GiftCards.", "example": [] }, "giftCardMessages": { "type": "array", "description": "GiftCardMessages.", "example": [] }, "availableAccounts": { "type": "array", "description": "Available accounts.", "example": [] }, "availableTokens": { "type": "array", "description": "Available tokens.", "example": [] } } } } } } } }, "Videos": { "type": "array", "description": "Videos.", "example": [] }, "estimatedDateArrival": { "type": "string", "description": "Estimated date arrival.", "nullable": true, "example": "" } } } } } } } } } } } } }, "/api/catalog_system/pub/products/search/{product-text-link}/p": { "get": { "tags": [ "Search" ], "summary": "Search product by product URL", "description": "Retrieves general information about the product of the URL you searched for.", "operationId": "Searchbyproducturl", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "product-text-link", "in": "path", "description": "Product URL", "required": true, "style": "simple", "schema": { "type": "string", "example": "blue-shirt" } } ], "responses": { "200": { "description": "", "headers": {}, "content": { "application/json": { "example": [ { "productId": "35", "productName": "Kit de Hoegaarden", "brand": "Hoegaarden", "brandId": 2000004, "brandImageUrl": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg", "linkText": "kit-6-cerveja-hoegaarden", "productReference": "000806", "productReferenceCode": null, "categoryId": "1", "productTitle": "", "metaTagDescription": "", "releaseDate": "2020-10-07T00:00:00", "clusterHighlights": { "138": "teste2" }, "productClusters": { "138": "teste2", "143": "NaoPesquisavel", "146": "colecaotestesubcategoria", "161": "merch_import_test1" }, "searchableClusters": { "138": "teste2" }, "categories": [ "/Beers Beers Mesmo/" ], "categoriesIds": [ "/1/" ], "link": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p", "Percentuals": [ "4,9" ], "Percentual": [ "4,9" ], "Total": [ "Percentuals", "Percentual" ], "Teste de Api": [ "a" ], "Ale": [ "1" ], "Teste da Api2": [ "Teste de Api", "Ale" ], "Alcool": [ "Percentual" ], "allSpecifications": [ "Percentuals", "Percentual", "Teste de Api", "Ale" ], "allSpecificationsGroups": [ "Total", "Teste da Api2" ], "description": "", "items": [ { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0000, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null } ] } ], "schema": { "type": "array", "items": { "type": "object", "required": [ "productId", "productName", "brand", "brandId", "brandImageUrl", "linkText", "productReference", "productReferenceCode", "categoryId", "productTitle", "metaTagDescription", "releaseDate", "clusterHighlights", "productClusters", "searchableClusters", "categories", "categoriesIds", "link", "Percentuals", "Percentual", "Total", "Teste de Api", "Ale", "Teste da Api2", "Alcool", "allSpecifications", "allSpecificationsGroups", "description", "items" ], "properties": { "productId": { "type": "string", "description": "Product unique identifier.", "example": "35" }, "productName": { "type": "string", "description": "Product name.", "example": "Kit de Hoegaarden" }, "brand": { "type": "string", "description": "Brand name.", "example": "Hoegaarden" }, "brandId": { "type": "integer", "description": "Product brand ID.", "example": 2000004 }, "brandImageUrl": { "type": "string", "description": "Product's brand image URL.", "example": "https://merch.vteximg.com.br/arquivos/ids/155532/hoegardden-logo.jpg" }, "linkText": { "type": "string", "description": "Product URL.", "example": "kit-6-cerveja-hoegaarden" }, "productReference": { "type": "string", "description": "Product reference.", "example": "000806" }, "productReferenceCode": { "type": "integer", "description": "Product reference ID.", "nullable": true, "example": 1234 }, "categoryId": { "type": "string", "description": "Product category ID.", "example": "1" }, "productTitle": { "type": "string", "description": "Text that is in the browser tab and corresponds to the title of the product page. This field is important for SEO.", "example": "Kit 6 cerveja Hoegaarden" }, "metaTagDescription": { "type": "string", "description": "Brief description of the category. It's recommended that you don't exceed 150 characters so that the search engines can display it correctly in the results page.", "example": "Category for Beers" }, "releaseDate": { "type": "string", "description": "Product release date.", "example": "2020-10-07T00:00:00" }, "clusterHighlights": { "type": "object", "description": "Cluster highlight ID and name.", "example": { "138": "teste2" } }, "productClusters": { "type": "object", "description": "Product clusters' IDs and names.", "example": { "138": "teste2", "143": "NaoPesquisavel", "146": "colecaotestesubcategoria", "161": "merch_import_test1" } }, "searchableClusters": { "type": "object", "description": "Searchable clusters IDs and names.", "example": { "138": "teste2" } }, "categories": { "type": "array", "description": "Array of the product's categories URLs.", "example": [ "/Beers Beers Mesmo/" ] }, "categoriesIds": { "type": "array", "description": "Array of the product's categories IDs.", "example": [ "/1/" ] }, "link": { "type": "string", "description": "Product URL.", "example": "https://merch.vtexcommercestable.com.br/kit-6-cerveja-hoegaarden/p" }, "allSpecifications": { "type": "array", "description": "Array of the product's specifications.", "example": [ "Percentuals", "Percentual" ], "items": { "type": "string", "description": "Product specification.", "example": "Percentual" } }, "allSpecificationsGroups": { "type": "array", "description": "Array of the product's specifications groups.", "example": [ "Total", "Teste da Api2" ], "items": { "type": "string", "description": "Product specification group.", "example": "Teste da Api2" } }, "description": { "type": "string", "description": "Description of the main information related to the product. A simple and easy to understand summary for the customer.", "example": "Description example", "nullable": true }, "items": { "type": "array", "description": "Array containing the product SKU general information.", "example": [ { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null } ], "items": { "type": "object", "example": { "itemId": "310118469", "name": "Kit com 6", "nameComplete": "Kit de Hoegaarden Kit com 6", "complementName": "", "ean": "", "referenceId": [ { "Key": "RefId", "Value": "000806" } ], "measurementUnit": "un", "unitMultiplier": 1.0, "modalType": null, "isKit": true, "kitItems": [ { "itemId": "310118466", "amount": 6 } ], "images": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "sellers": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "Videos": [], "estimatedDateArrival": null }, "required": [ "itemId", "name", "nameComplete", "complementName", "ean", "referenceId", "measurementUnit", "unitMultiplier", "modalType", "isKit", "kitItems", "images", "sellers", "Videos", "estimatedDateArrival" ], "properties": { "itemId": { "type": "string", "description": "SKU ID.", "example": "310118469" }, "name": { "type": "string", "description": "SKU name.", "example": "Kit com 6" }, "nameComplete": { "type": "string", "description": "SKU complete name.", "example": "Kit de Hoegaarden Kit com 6" }, "complementName": { "type": "string", "description": "SKU complement name.", "example": "Complement name" }, "ean": { "type": "string", "description": "SKU unique identification code (barcode), accepts up to 13 numerical characters.", "example": "12345567" }, "referenceId": { "type": "array", "description": "Reference code ID.", "example": [ { "Key": "RefId", "Value": "000806" } ], "items": { "type": "object", "example": { "Key": "RefId", "Value": "000806" }, "required": [ "Key", "Value" ], "properties": { "Key": { "type": "string", "description": "Reference Code.", "example": "RefId" }, "Value": { "type": "string", "description": "Unique reference code used internally for organizational purposes.", "example": "000806" } } } }, "measurementUnit": { "type": "string", "description": "Used only in cases when you need to convert the unit of measure for sale. In common cases, use 'un'.", "example": "un" }, "unitMultiplier": { "type": "number", "description": "numerical unit that multiplies the selected quantity of the product when it is inserted in the cart.", "example": 1.0 }, "modalType": { "type": "string", "description": "Modal Type.", "nullable": true, "example": "Modal Type test" }, "isKit": { "type": "boolean", "description": "If the SKU is part of a kit.", "example": true }, "kitItems": { "type": "array", "description": "Array with information of SKUs components from a Kit.", "example": [ { "itemId": "310118466", "amount": 6 } ], "items": { "type": "object", "example": { "itemId": "310118466", "amount": 6 }, "required": [ "itemId", "amount" ], "properties": { "itemId": { "type": "string", "description": "SKU kit component ID.", "example": "310118466" }, "amount": { "type": "integer", "description": "Amount of the SKU component in the kit.", "example": 6 } } } }, "images": { "type": "array", "description": "Array of information about the SKU image.", "example": [ { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" } ], "items": { "type": "object", "example": { "imageId": "155489", "imageLabel": "", "imageTag": "\"hoegaarden-kit\"", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000", "imageText": "hoegaarden-kit", "imageLastModified": "2020-10-07T12:49:27.5800000Z" }, "required": [ "imageId", "imageLabel", "imageTag", "imageUrl", "imageText", "imageLastModified" ], "properties": { "imageId": { "type": "string", "description": "Image ID.", "example": "155489" }, "imageLabel": { "type": "string", "description": "Image label.", "example": "Label test" }, "imageTag": { "type": "string", "description": "Image tag.", "example": "\"hoegaarden-kit\"" }, "imageUrl": { "type": "string", "description": "Image URL.", "example": "https://merch.vteximg.com.br/arquivos/ids/155489/99B14097-BFEA-4C0E-899E-35C95A2E1509_4_5005_c.jpg?v=637376717675800000" }, "imageText": { "type": "string", "description": "Image text.", "nullable": true, "example": "hoegaarden-kit" }, "imageLastModified": { "type": "string", "description": "Date and time of the last update of the image.", "example": "2020-10-07T12:49:27.5800000Z" } } } }, "sellers": { "type": "array", "description": "Array of SKU sellers.", "example": [ { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } } ], "items": { "type": "object", "example": { "sellerId": "1", "sellerName": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE", "addToCartLink": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1", "sellerDefault": true, "commertialOffer": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } } }, "required": [ "sellerId", "sellerName", "addToCartLink", "sellerDefault", "commertialOffer" ], "properties": { "sellerId": { "type": "string", "description": "SKU seller ID.", "example": "1" }, "sellerName": { "type": "string", "description": "SKU seller name.", "example": "COMPANHIA BRASILEIRA DE TECNOLOGIA PARA E-COMMERCE" }, "addToCartLink": { "type": "string", "description": "URL to add the product to the cart.", "example": "https://merch.vtexcommercestable.com.br/checkout/cart/add?sku=310118469&qty=1&seller=1&sc=1&price=4200&cv=95EF7E5476DF276E679167A399FE3103_&sc=1" }, "sellerDefault": { "type": "boolean", "description": "If the seller is default or not.", "example": true }, "commertialOffer": { "type": "object", "description": "AKA Commertial Condition.", "example": { "DeliverySlaSamplesPerRegion": { "0": { "DeliverySlaPerTypes": [], "Region": null } }, "Installments": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" }, { "Value": 14.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 3, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 3 vezes sem juros" }, { "Value": 10.5, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 4, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 4 vezes sem juros" }, { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Promissory", "PaymentSystemGroupName": "promissoryPaymentGroup", "Name": "Promissory à vista" } ], "DiscountHighLight": [], "GiftSkuIds": [], "Teasers": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "PromotionTeasers": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "BuyTogether": [], "ItemMetadataAttachment": [], "Price": 42.0, "ListPrice": 42.0, "PriceWithoutDiscount": 42.0, "RewardValue": 0.0, "PriceValidUntil": "4000-01-01T03:00:00Z", "AvailableQuantity": 16, "IsAvailable": true, "Tax": 0.0, "SaleChannel": 0, "DeliverySlaSamples": [ { "DeliverySlaPerTypes": [], "Region": null } ], "GetInfoErrorMessage": null, "CacheVersionUsedToCallCheckout": "95EF7E5476DF276E679167A399FE3103_", "PaymentOptions": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] } }, "required": [ "DeliverySlaSamplesPerRegion", "Installments", "DiscountHighLight", "GiftSkuIds", "Teasers", "BuyTogether", "ItemMetadataAttachment", "Price", "ListPrice", "PriceWithoutDiscount", "RewardValue", "PriceValidUntil", "AvailableQuantity", "IsAvailable", "Tax", "SaleChannel", "DeliverySlaSamples", "GetInfoErrorMessage", "CacheVersionUsedToCallCheckout", "PaymentOptions" ], "properties": { "DeliverySlaSamplesPerRegion": { "type": "object", "description": "Delivery SLA samples per region.", "example": { "0": { "DeliverySlaPerTypes": [], "Region": "null" } }, "properties": { "0": { "type": "object", "description": "Delivery SLA ID.", "example": { "DeliverySlaPerTypes": [], "Region": null }, "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "example": [] }, "Region": { "type": "string", "description": "Region.", "nullable": true, "example": "" } } } } }, "Installments": { "type": "array", "description": "Installments options.", "example": [ { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, { "Value": 21.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 2, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa 2 vezes sem juros" } ], "items": { "type": "object", "example": { "Value": 42.0, "InterestRate": 0.0, "TotalValuePlusInterestRate": 42.0, "NumberOfInstallments": 1, "PaymentSystemName": "Visa", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "Visa à vista" }, "required": [ "Value", "InterestRate", "TotalValuePlusInterestRate", "NumberOfInstallments", "PaymentSystemName", "PaymentSystemGroupName", "Name" ], "properties": { "Value": { "type": "number", "description": "Value of the installment.", "example": 42.0 }, "InterestRate": { "type": "number", "description": "Interest rate of the installment.", "example": 0.0 }, "TotalValuePlusInterestRate": { "type": "number", "description": "Total value plus interest rate of the installment.", "example": 42.0 }, "NumberOfInstallments": { "type": "integer", "description": "Number of the installment.", "example": 1 }, "PaymentSystemName": { "type": "string", "description": "Payment system name of the installment.", "example": "Visa" }, "PaymentSystemGroupName": { "type": "string", "description": "Payment system group name of the installment.", "example": "creditCardPaymentGroup" }, "Name": { "type": "string", "description": "Name of the installment.", "example": "Visa à vista" } } } }, "DiscountHighLight": { "type": "array", "description": "Discount hightlight.", "example": [] }, "GiftSkuIds": { "type": "array", "description": "Array of SKU gifts IDs.", "example": [] }, "Teasers": { "type": "array", "description": "List with promotions teasers.", "example": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "items": { "type": "object", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}.", "properties": { "{field}": { "type": "string", "example": "{value}" } } }, "k__BackingField": { "type": "object", "description": "Conditions.", "properties": { "k__BackingField": { "type": "integer", "description": "Minimum quantity." }, "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } }, "k__BackingField": { "type": "object", "description": "Effects.", "properties": { "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } } } } }, "PromotionTeasers": { "type": "array", "description": "List with promotions teasers.", "example": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name." }, "GeneralValues": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}.", "properties": { "{field}": { "type": "string", "example": "{value}" } } }, "Conditions": { "type": "object", "description": "Conditions.", "properties": { "MinimumQuantity": { "type": "integer", "description": "Minimum quantity." }, "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } }, "Effects": { "type": "object", "description": "Effects.", "properties": { "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } } } } }, "BuyTogether": { "type": "array", "description": "Array of other products that can be bought together with the product in question.", "example": [] }, "ItemMetadataAttachment": { "type": "array", "description": "Item metadata attachment.", "example": [] }, "Price": { "type": "number", "description": "Price of the product.", "example": 42.0 }, "ListPrice": { "type": "number", "description": "List price of the product.", "example": 42.0 }, "PriceWithoutDiscount": { "type": "number", "description": "Price of the product without discount.", "example": 42.0 }, "RewardValue": { "type": "number", "description": "Reward value of the product.", "example": 0.0 }, "PriceValidUntil": { "type": "string", "description": "Price of the product valid until a certain date.", "example": "4000-01-01T03:00:00Z" }, "AvailableQuantity": { "type": "integer", "description": "Use the `IsAvailable` field instead.", "example": 16 }, "IsAvailable": { "type": "boolean", "description": "If the product is available or not.", "example": true }, "Tax": { "type": "number", "description": "Tax of the product.", "example": 0.0 }, "SaleChannel": { "type": "integer", "description": "Trade policy which the product is contained.", "example": 0 }, "DeliverySlaSamples": { "type": "array", "description": "Delivery SLA samples.", "example": [ { "DeliverySlaPerTypes": [], "Region": null } ], "items": { "type": "object", "example": { "DeliverySlaPerTypes": [], "Region": null }, "required": [ "DeliverySlaPerTypes", "Region" ], "properties": { "DeliverySlaPerTypes": { "type": "array", "description": "Delivery SLA per types.", "example": [] }, "Region": { "type": "string", "description": "Region.", "nullable": true, "example": null } } } }, "GetInfoErrorMessage": { "type": "string", "description": "Get info error message.", "nullable": true, "example": null }, "CacheVersionUsedToCallCheckout": { "type": "string", "description": "Cache version used to call checkout.", "example": "95EF7E5476DF276E679167A399FE3103_" }, "PaymentOptions": { "type": "object", "description": "Payment options.", "example": { "installmentOptions": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "paymentSystems": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "payments": [], "giftCards": [], "giftCardMessages": [], "availableAccounts": [], "availableTokens": [] }, "required": [ "installmentOptions", "paymentSystems", "payments", "giftCards", "giftCardMessages", "availableAccounts", "availableTokens" ], "properties": { "installmentOptions": { "type": "array", "description": "installment options.", "example": [ { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, { "paymentSystem": "17", "bin": null, "paymentName": "Promissory", "paymentGroupName": "promissoryPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] } ] } ], "items": { "type": "object", "example": { "paymentSystem": "2", "bin": null, "paymentName": "Visa", "paymentGroupName": "creditCardPaymentGroup", "value": 4200, "installments": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] }, { "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 3, "hasInterestRate": false, "interestRate": 0, "value": 1400, "total": 4200 } ] }, { "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 4, "hasInterestRate": false, "interestRate": 0, "value": 1050, "total": 4200 } ] } ] }, "required": [ "paymentSystem", "bin", "paymentName", "paymentGroupName", "value", "installments" ], "properties": { "paymentSystem": { "type": "string", "description": "Payment system.", "example": "2" }, "bin": { "type": "string", "description": "Bin.", "nullable": true, "example": null }, "paymentName": { "type": "string", "description": "Payment name.", "example": "Visa" }, "paymentGroupName": { "type": "string", "description": "Payment group name.", "example": "creditCardPaymentGroup" }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "installments": { "type": "array", "description": "Installments.", "example": [ { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, { "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 2, "hasInterestRate": false, "interestRate": 0, "value": 2100, "total": 4200 } ] } ], "items": { "type": "object", "example": { "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200, "sellerMerchantInstallments": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ] }, "required": [ "count", "hasInterestRate", "interestRate", "value", "total", "sellerMerchantInstallments" ], "properties": { "count": { "type": "integer", "description": "Count.", "example": 1 }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate.", "example": false }, "interestRate": { "type": "integer", "description": "Interest rate.", "example": 0 }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "total": { "type": "integer", "description": "Total.", "example": 4200 }, "sellerMerchantInstallments": { "type": "array", "description": "Seller merchant installments.", "example": [ { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 } ], "items": { "type": "object", "example": { "id": "MERCH", "count": 1, "hasInterestRate": false, "interestRate": 0, "value": 4200, "total": 4200 }, "required": [ "id", "count", "hasInterestRate", "interestRate", "value", "total" ], "properties": { "id": { "type": "string", "description": "ID.", "example": "MERCH" }, "count": { "type": "integer", "description": "Count.", "example": 1 }, "hasInterestRate": { "type": "boolean", "description": "Has interest rate.", "example": false }, "interestRate": { "type": "integer", "description": "Interest rate.", "example": 0 }, "value": { "type": "integer", "description": "Value.", "example": 4200 }, "total": { "type": "integer", "description": "Total.", "example": 4200 } } } } } } } } } }, "paymentSystems": { "type": "array", "description": "Payment systems.", "example": [ { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, { "id": 2, "name": "Visa", "groupName": "creditCardPaymentGroup", "validator": null, "stringId": "2", "template": "creditCardPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null } ], "items": { "type": "object", "example": { "id": 17, "name": "Promissory", "groupName": "promissoryPaymentGroup", "validator": null, "stringId": "17", "template": "promissoryPaymentGroup-template", "requiresDocument": false, "isCustom": false, "description": null, "requiresAuthentication": false, "dueDate": "2021-07-01T18:43:00.0264384Z", "availablePayments": null }, "required": [ "id", "name", "groupName", "validator", "stringId", "template", "requiresDocument", "isCustom", "description", "requiresAuthentication", "dueDate", "availablePayments" ], "properties": { "id": { "type": "integer", "description": "ID.", "example": 17 }, "name": { "type": "string", "description": "Name.", "example": "Promissory" }, "groupName": { "type": "string", "description": "Group name.", "example": "promissoryPaymentGroup" }, "validator": { "type": "string", "description": "Validator.", "nullable": true, "example": "" }, "stringId": { "type": "string", "description": "String ID.", "example": "17" }, "template": { "type": "string", "description": "Template.", "example": "promissoryPaymentGroup-template" }, "requiresDocument": { "type": "boolean", "description": "If requires document or not.", "example": false }, "isCustom": { "type": "boolean", "description": "If is custom or not.", "example": false }, "description": { "type": "string", "description": "Description.", "nullable": true, "example": "" }, "requiresAuthentication": { "type": "boolean", "description": "If requires authentication.", "example": false }, "dueDate": { "type": "string", "description": "Due date.", "example": "2021-07-01T18:43:00.0264384Z" }, "availablePayments": { "type": "string", "description": "Available payments.", "nullable": true, "example": "" } } } }, "payments": { "type": "array", "description": "Payments.", "example": [] }, "giftCards": { "type": "array", "description": "GiftCards.", "example": [] }, "giftCardMessages": { "type": "array", "description": "GiftCardMessages.", "example": [] }, "availableAccounts": { "type": "array", "description": "Available accounts.", "example": [] }, "availableTokens": { "type": "array", "description": "Available tokens.", "example": [] } } } } } } } }, "Videos": { "type": "array", "description": "Videos.", "example": [] }, "estimatedDateArrival": { "type": "string", "description": "Estimated date arrival.", "nullable": true, "example": "" } } } } } } } } } } } } }, "/api/catalog_system/pub/products/offers/{productId}": { "get": { "tags": [ "Offers" ], "summary": "Search product offers", "description": "Retrieves existing offers of a specific product.", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "productId", "in": "path", "description": "Product unique number identifier.", "required": true, "style": "simple", "schema": { "type": "string", "example": "3" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "SkuId": "5", "EanId": "272727", "RefId": "BIGHEROBML", "Name": "Llf", "NameComplete": "Cacilds Llf", "IsActive": true, "MainImage": { "ImageId": "172754", "ImageLabel": null, "ImageTag": "\"\"", "ImagePath": "~/arquivos/ids/172754-#width#-#height#/Diablo.jpg", "IsMain": true, "IsZoomSize": false, "ImageText": null, "LastModified": "2021-03-24T15:37:24.877" }, "Offers": [ { "SellerId": "1", "SellerSkuId": "5", "OffersPerSalesChannel": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "AvailableSalesChannels": null } ], "LastModified": "2021-07-06T19:13:45.831483", "ProductId": "3" } ], "schema": { "type": "array", "example": [ { "SkuId": "5", "EanId": "272727", "RefId": "BIGHEROBML", "Name": "Llf", "NameComplete": "Cacilds Llf", "IsActive": true, "MainImage": { "ImageId": "172754", "ImageLabel": null, "ImageTag": "\"\"", "ImagePath": "~/arquivos/ids/172754-#width#-#height#/Diablo.jpg", "IsMain": true, "IsZoomSize": false, "ImageText": null, "LastModified": "2021-03-24T15:37:24.877" }, "Offers": [ { "SellerId": "1", "SellerSkuId": "5", "OffersPerSalesChannel": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "AvailableSalesChannels": null } ], "LastModified": "2021-07-06T19:13:45.831483", "ProductId": "3" } ], "items": { "type": "object", "example": { "SkuId": "5", "EanId": "272727", "RefId": "BIGHEROBML", "Name": "Llf", "NameComplete": "Cacilds Llf", "IsActive": true, "MainImage": { "ImageId": "172754", "ImageLabel": null, "ImageTag": "\"\"", "ImagePath": "~/arquivos/ids/172754-#width#-#height#/Diablo.jpg", "IsMain": true, "IsZoomSize": false, "ImageText": null, "LastModified": "2021-03-24T15:37:24.877" }, "Offers": [ { "SellerId": "1", "SellerSkuId": "5", "OffersPerSalesChannel": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "AvailableSalesChannels": null } ], "LastModified": "2021-07-06T19:13:45.831483", "ProductId": "3" }, "required": [ "SkuId", "EanId", "RefId", "Name", "NameComplete", "IsActive", "MainImage", "Offers", "LastModified", "ProductId" ], "properties": { "SkuId": { "type": "string", "description": "SKU ID.", "example": "5" }, "EanId": { "type": "string", "description": "SKU unique identification code (barcode), accepts up to 13 numerical characters.", "example": "272727" }, "RefId": { "type": "string", "description": "Unique reference code used internally for organizational purposes.", "example": "BIGHEROBML" }, "Name": { "type": "string", "description": "SKU name.", "example": "Llf" }, "NameComplete": { "type": "string", "description": "SKU complete name.", "example": "Cacilds Llf" }, "IsActive": { "type": "boolean", "description": "If the SKU is active or not.", "example": true }, "MainImage": { "type": "object", "description": "General information of the main image of the SKU.", "example": { "ImageId": "172754", "ImageLabel": null, "ImageTag": "\"\"", "ImagePath": "~/arquivos/ids/172754-#width#-#height#/Diablo.jpg", "IsMain": true, "IsZoomSize": false, "ImageText": null, "LastModified": "2021-03-24T15:37:24.877" }, "required": [ "ImageId", "ImageLabel", "ImageTag", "ImagePath", "IsMain", "IsZoomSize", "ImageText", "LastModified" ], "properties": { "ImageId": { "type": "string", "description": "Unique identifier of the association of the Image to the SKU.", "example": "172754" }, "ImageLabel": { "type": "string", "description": "Image Label.", "nullable": true, "example": "" }, "ImageTag": { "type": "string", "description": "Image HTML tag.", "example": "\"\"" }, "ImagePath": { "type": "string", "description": "Image file path.", "example": "~/arquivos/ids/172754-#width#-#height#/Diablo.jpg" }, "IsMain": { "type": "boolean", "description": "If the image is the main image of the SKU or not.", "example": true }, "IsZoomSize": { "type": "boolean", "description": "If the image has zoom applied.", "example": false }, "ImageText": { "type": "string", "description": "General text of the image.", "nullable": true, "example": "" }, "LastModified": { "type": "string", "description": "Time that the image was last modified.", "example": "2021-03-24T15:37:24.877" } } }, "Offers": { "type": "array", "description": "AKA Commertial Condition.", "example": [ { "SellerId": "1", "SellerSkuId": "5", "OffersPerSalesChannel": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "AvailableSalesChannels": null } ], "items": { "type": "object", "example": { "SellerId": "1", "SellerSkuId": "5", "OffersPerSalesChannel": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "AvailableSalesChannels": null }, "required": [ "SellerId", "SellerSkuId", "OffersPerSalesChannel", "AvailableSalesChannels" ], "properties": { "SellerId": { "type": "string", "description": "Seller ID.", "example": "1" }, "SellerSkuId": { "type": "string", "description": "ID of the association of the SKU with the seller.", "example": "5" }, "OffersPerSalesChannel": { "type": "array", "description": "Offers per trade policy.", "example": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "items": { "type": "object", "example": { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, "required": [ "AvailableQuantity", "SaleChannel", "Price", "ListPrice", "PriceWithoutDiscount", "IsAvailable" ], "properties": { "AvailableQuantity": { "type": "integer", "description": "SKU available quantity.", "example": 50 }, "SaleChannel": { "type": "integer", "description": "SKU trade policy.", "example": 1 }, "Price": { "type": "number", "description": "SKU price.", "example": 200.0 }, "ListPrice": { "type": "number", "description": "SKU list price.", "example": 200.0 }, "PriceWithoutDiscount": { "type": "number", "description": "SKU precie without discount.", "example": 200.0 }, "IsAvailable": { "type": "boolean", "description": "If the SKU is available or not.", "example": true } } } }, "AvailableSalesChannels": { "type": "string", "nullable": true, "description": "Trade policy that the SKU in contained.", "example": "" } } } }, "LastModified": { "type": "string", "description": "Time that the offer was last modified.", "example": "2021-07-06T19:13:45.831483" }, "ProductId": { "type": "string", "description": "Product ID.", "example": "3" } } } } } } } } } }, "/api/catalog_system/pub/products/offers/{productId}/sku/{skuId}": { "get": { "tags": [ "Offers" ], "summary": "Search SKU offers", "description": "Retrieves existing offers of a specific SKU.", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "productId", "in": "path", "description": "Product unique number identifier.", "required": true, "style": "simple", "schema": { "type": "string", "example": "3" } }, { "name": "skuId", "in": "path", "description": "Product unique number identifier.", "required": true, "style": "simple", "schema": { "type": "string", "example": "5" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "SkuId": "5", "EanId": "272727", "RefId": "BIGHEROBML", "Name": "Llf", "NameComplete": "Cacilds Llf", "IsActive": true, "MainImage": { "ImageId": "172754", "ImageLabel": null, "ImageTag": "\"\"", "ImagePath": "~/arquivos/ids/172754-#width#-#height#/Diablo.jpg", "IsMain": true, "IsZoomSize": false, "ImageText": null, "LastModified": "2021-03-24T15:37:24.877" }, "Offers": [ { "SellerId": "1", "SellerSkuId": "5", "OffersPerSalesChannel": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "AvailableSalesChannels": null } ], "LastModified": "2021-07-06T19:13:45.831483", "ProductId": "3" } ], "schema": { "type": "array", "example": [ { "SkuId": "5", "EanId": "272727", "RefId": "BIGHEROBML", "Name": "Llf", "NameComplete": "Cacilds Llf", "IsActive": true, "MainImage": { "ImageId": "172754", "ImageLabel": null, "ImageTag": "\"\"", "ImagePath": "~/arquivos/ids/172754-#width#-#height#/Diablo.jpg", "IsMain": true, "IsZoomSize": false, "ImageText": null, "LastModified": "2021-03-24T15:37:24.877" }, "Offers": [ { "SellerId": "1", "SellerSkuId": "5", "OffersPerSalesChannel": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "AvailableSalesChannels": null } ], "LastModified": "2021-07-06T19:13:45.831483", "ProductId": "3" } ], "items": { "type": "object", "example": { "SkuId": "5", "EanId": "272727", "RefId": "BIGHEROBML", "Name": "Llf", "NameComplete": "Cacilds Llf", "IsActive": true, "MainImage": { "ImageId": "172754", "ImageLabel": null, "ImageTag": "\"\"", "ImagePath": "~/arquivos/ids/172754-#width#-#height#/Diablo.jpg", "IsMain": true, "IsZoomSize": false, "ImageText": null, "LastModified": "2021-03-24T15:37:24.877" }, "Offers": [ { "SellerId": "1", "SellerSkuId": "5", "OffersPerSalesChannel": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "AvailableSalesChannels": null } ], "LastModified": "2021-07-06T19:13:45.831483", "ProductId": "3" }, "required": [ "SkuId", "EanId", "RefId", "Name", "NameComplete", "IsActive", "MainImage", "Offers", "LastModified", "ProductId" ], "properties": { "SkuId": { "type": "string", "description": "SKU ID.", "example": "5" }, "EanId": { "type": "string", "description": "SKU unique identification code (barcode), accepts up to 13 numerical characters.", "example": "272727" }, "RefId": { "type": "string", "description": "Unique reference code used internally for organizational purposes.", "example": "BIGHEROBML" }, "Name": { "type": "string", "description": "SKU name.", "example": "Llf" }, "NameComplete": { "type": "string", "description": "SKU complete name.", "example": "Cacilds Llf" }, "IsActive": { "type": "boolean", "description": "If the SKU is active or not.", "example": true }, "MainImage": { "type": "object", "description": "General information of the main image of the SKU.", "example": { "ImageId": "172754", "ImageLabel": null, "ImageTag": "\"\"", "ImagePath": "~/arquivos/ids/172754-#width#-#height#/Diablo.jpg", "IsMain": true, "IsZoomSize": false, "ImageText": null, "LastModified": "2021-03-24T15:37:24.877" }, "required": [ "ImageId", "ImageLabel", "ImageTag", "ImagePath", "IsMain", "IsZoomSize", "ImageText", "LastModified" ], "properties": { "ImageId": { "type": "string", "description": "Unique identifier of the association of the Image to the SKU.", "example": "172754" }, "ImageLabel": { "type": "string", "description": "Image Label.", "nullable": true, "example": "" }, "ImageTag": { "type": "string", "description": "Image HTML tag.", "example": "\"\"" }, "ImagePath": { "type": "string", "description": "Image file path.", "example": "~/arquivos/ids/172754-#width#-#height#/Diablo.jpg" }, "IsMain": { "type": "boolean", "description": "If the image is the main image of the SKU or not.", "example": true }, "IsZoomSize": { "type": "boolean", "description": "If the image has zoom applied.", "example": false }, "ImageText": { "type": "string", "description": "General text of the image.", "nullable": true, "example": "" }, "LastModified": { "type": "string", "description": "Time that the image was last modified.", "example": "2021-03-24T15:37:24.877" } } }, "Offers": { "type": "array", "description": "AKA Commertial Condition.", "example": [ { "SellerId": "1", "SellerSkuId": "5", "OffersPerSalesChannel": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "AvailableSalesChannels": null } ], "items": { "type": "object", "example": { "SellerId": "1", "SellerSkuId": "5", "OffersPerSalesChannel": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "AvailableSalesChannels": null }, "required": [ "SellerId", "SellerSkuId", "OffersPerSalesChannel", "AvailableSalesChannels" ], "properties": { "SellerId": { "type": "string", "description": "Seller ID.", "example": "1" }, "SellerSkuId": { "type": "string", "description": "ID of the association of the SKU with the seller.", "example": "5" }, "OffersPerSalesChannel": { "type": "array", "description": "Offers per trade policy.", "example": [ { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, { "AvailableQuantity": 0, "SaleChannel": 2, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false } ], "items": { "type": "object", "example": { "AvailableQuantity": 0, "SaleChannel": 1, "Price": 200.0, "ListPrice": 200.0, "PriceWithoutDiscount": 200.0, "IsAvailable": false }, "required": [ "AvailableQuantity", "SaleChannel", "Price", "ListPrice", "PriceWithoutDiscount", "IsAvailable" ], "properties": { "AvailableQuantity": { "type": "integer", "description": "SKU available quantity.", "example": 50 }, "SaleChannel": { "type": "integer", "description": "SKU trade policy.", "example": 1 }, "Price": { "type": "number", "description": "SKU price.", "example": 200.0 }, "ListPrice": { "type": "number", "description": "SKU list price.", "example": 200.0 }, "PriceWithoutDiscount": { "type": "number", "description": "SKU precie without discount.", "example": 200.0 }, "IsAvailable": { "type": "boolean", "description": "If the SKU is available or not.", "example": true } } } }, "AvailableSalesChannels": { "type": "string", "description": "Trade policy that the SKU in contained.", "nullable": true, "example": "" } } } }, "LastModified": { "type": "string", "description": "Time that the offer was last modified.", "example": "2021-07-06T19:13:45.831483" }, "ProductId": { "type": "string", "description": "Product ID.", "example": "3" } } } } } } } } } }, "/api/catalog_system/pub/facets/category/{categoryId}": { "get": { "tags": [ "Facets" ], "summary": "Get category facets", "description": "Retrieves the names and IDs of the categories facets. \r\n>⚠️ This endpoint returns a maximum of 50 items per response, so the difference between `_from` and `_to` should not exceed this number. The result order is descending, from the highest product ID to the lowest.\r\n\r\n## Response body example:\r\n\r\n```json\r\n[\r\n\t[\r\n {\r\n \"Name\":\"Tamanho Global\",\r\n \"Id\":45\r\n\t\t},\r\n\t\t{\r\n \"Name\":\"Percentuals\",\r\n \"Id\":25\r\n\t\t}\r\n\t]\r\n]\r\n```", "parameters": [ { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "categoryId", "in": "path", "description": "Category unique number identifier.", "required": true, "style": "simple", "schema": { "type": "string", "example": "1" } }, { "name": "_from", "in": "query", "description": "Starter page range. These parameters allow the API to be paginated. Take into account that the initial and final pages cannot have a separation superior to 50 pages. Thus, it will be displayed 50 items per page.", "required": false, "style": "form", "schema": { "type": "string", "example": "1" } }, { "name": "_to", "in": "query", "description": "Finisher page range. These parameters allow the API to be paginated. Take into account that the initial and final pages cannot have a separation superior to 50 pages. Thus, it will be displayed 50 items per page.", "required": false, "style": "form", "schema": { "type": "string", "example": "50" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "example": [ { "Name": "Tamanho Global", "Id": 45 }, { "Name": "Percentuals", "Id": 25 } ], "schema": { "type": "array", "items": { "type": "object", "description": "Object with name and ID of the category's facet.", "example": { "Name": "Tamanho Global", "Id": 45 }, "required": [ "Name", "Id" ], "properties": { "Name": { "type": "string", "description": "Category's facet name.", "example": "Tamanho Global" }, "Id": { "type": "integer", "description": "Category's facet ID.", "example": 45 } } } } } } } } } }, "/api/catalog_system/pub/facets/search/{term}": { "get": { "tags": [ "Facets" ], "summary": "Search by store facets", "description": "Retrieves products by store facets. The result order is descending, from the highest product ID to the lowest.", "operationId": "Facetscategory", "parameters": [ { "name": "map", "in": "query", "description": "Mapping of the term. It can be `c` for a category, `b` for a brand, or `specificationFilter_{specificationId}` for a specification. You need to include a map for each term you are searching for in the same term's order.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "c" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Content-Type", "in": "header", "description": "Describes the type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "term", "in": "path", "description": "Term used for the facet's search. You can search for as much term as you want. The term can be: `categoryId`, `brandId`, `specificationId`.", "required": true, "style": "simple", "schema": { "type": "string", "example": "2" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "Departments", "Brands", "SpecificationFilters", "CategoriesTrees", "PriceRanges", "Summary" ], "properties": { "Departments": { "type": "array", "description": "Array of general information about the categories.", "example": [ { "Quantity": 2, "Position": null, "Name": "Beers Beers Mesmo", "Link": "/Beers-Beers-Mesmo/1?map=c,b", "LinkEncoded": "/Beers-Beers-Mesmo/1?map=c,b", "Map": "c", "Value": "Beers-Beers-Mesmo" }, { "Quantity": 2, "Position": null, "Name": "Merch Integration Category ||", "Link": "/Merch-Integration-Category-||/1?map=c,b", "LinkEncoded": "/Merch-Integration-Category-%7C%7C/1?map=c,b", "Map": "c", "Value": "Merch-Integration-Category-||" } ], "items": { "type": "object", "example": { "Quantity": 2, "Position": null, "Name": "Beers Beers Mesmo", "Link": "/Beers-Beers-Mesmo/1?map=c,b", "LinkEncoded": "/Beers-Beers-Mesmo/1?map=c,b", "Map": "c", "Value": "Beers-Beers-Mesmo" }, "required": [ "Quantity", "Position", "Name", "Link", "LinkEncoded", "Map", "Value" ], "properties": { "Quantity": { "type": "integer", "description": "Quantity of facets.", "example": 2 }, "Position": { "type": "integer", "description": "Position of the facets.", "nullable": true, "example": 1 }, "Name": { "type": "string", "description": "Category name.", "example": "Beers Beers Mesmo" }, "Link": { "type": "string", "description": "Link of the facet.", "example": "/Beers-Beers-Mesmo/1?map=c,b" }, "LinkEncoded": { "type": "string", "description": "Encoded link of the facet.", "example": "/Beers-Beers-Mesmo/1?map=c,b" }, "Map": { "type": "string", "description": "Mapping of the facet.", "example": "c" }, "Value": { "type": "string", "description": "Value of the facet.", "example": "Beers-Beers-Mesmo" } } } }, "Brands": { "type": "array", "description": "Array of general information about the brands.", "example": [ { "Quantity": 2, "Position": null, "Name": "Merch XP", "Link": "/1/1234600/1/Merch-XP?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Merch-XP?map=c,c,b,b", "Map": "b", "Value": "Merch-XP" }, { "Quantity": 2, "Position": null, "Name": "Zé", "Link": "/1/1234600/1/Ze?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Ze?map=c,c,b,b", "Map": "b", "Value": "Ze" } ], "items": { "type": "object", "example": { "Quantity": 2, "Position": null, "Name": "Merch XP", "Link": "/1/1234600/1/Merch-XP?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Merch-XP?map=c,c,b,b", "Map": "b", "Value": "Merch-XP" }, "required": [ "Quantity", "Position", "Name", "Link", "LinkEncoded", "Map", "Value" ], "properties": { "Quantity": { "type": "integer", "description": "Quantity of facets.", "example": 2 }, "Position": { "type": "integer", "description": "Position of the facet.", "nullable": true, "example": 1 }, "Name": { "type": "string", "description": "Brand name.", "example": "Merch XP" }, "Link": { "type": "string", "description": "Link of the facet.", "example": "/1/1234600/1/Merch-XP?map=c,c,b,b" }, "LinkEncoded": { "type": "string", "description": "Enconded link of the facet.", "example": "/1/1234600/1/Merch-XP?map=c,c,b,b" }, "Map": { "type": "string", "description": "Mapping of the facet.", "example": "b" }, "Value": { "type": "string", "description": "Value of the facet.", "example": "Merch-XP" } } } }, "SpecificationFilters": { "type": "object", "description": "Object with general information of specifications.", "example": {} }, "CategoriesTrees": { "type": "array", "description": "Array of the category tree.", "example": [ { "Id": 1, "Quantity": 4, "Position": null, "Name": "Beers Beers Mesmo", "Link": "/Beers-Beers-Mesmo/1?map=c,b", "LinkEncoded": "/Beers-Beers-Mesmo/1?map=c,b", "Map": "c", "Value": "Beers-Beers-Mesmo", "Children": [ { "Id": 2, "Quantity": 1, "Position": null, "Name": "Lager Beers", "Link": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b", "LinkEncoded": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b", "Map": "c", "Value": "Lager-Beers", "Children": [] } ] }, { "Id": 1234571, "Quantity": 2, "Position": null, "Name": "Jogos", "Link": "/Jogos/1?map=c,b", "LinkEncoded": "/Jogos/1?map=c,b", "Map": "c", "Value": "Jogos", "Children": [] } ], "items": { "type": "object", "example": { "Id": 1, "Quantity": 4, "Position": null, "Name": "Beers Beers Mesmo", "Link": "/Beers-Beers-Mesmo/1?map=c,b", "LinkEncoded": "/Beers-Beers-Mesmo/1?map=c,b", "Map": "c", "Value": "Beers-Beers-Mesmo", "Children": [ { "Id": 2, "Quantity": 1, "Position": null, "Name": "Lager Beers", "Link": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b", "LinkEncoded": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b", "Map": "c", "Value": "Lager-Beers", "Children": [] } ] }, "required": [ "Id", "Quantity", "Position", "Name", "Link", "LinkEncoded", "Map", "Value", "Children" ], "properties": { "Id": { "type": "integer", "description": "Category ID.", "example": 1 }, "Quantity": { "type": "integer", "description": "Quantity of the facets.", "example": 4 }, "Position": { "type": "integer", "description": "Position of the facet.", "nullable": true, "example": 1 }, "Name": { "type": "string", "description": "Category name.", "example": "Beers Beers Mesmo" }, "Link": { "type": "string", "description": "Link of the facet.", "example": "/Beers-Beers-Mesmo/1?map=c,b" }, "LinkEncoded": { "type": "string", "description": "Encoded link of the facet.", "example": "/Beers-Beers-Mesmo/1?map=c,b" }, "Map": { "type": "string", "description": "Mapping of the facet.", "example": "c" }, "Value": { "type": "string", "description": "Value of the facet.", "example": "Beers-Beers-Mesmo" }, "Children": { "type": "array", "description": "Category children.", "example": [ { "Id": 2, "Quantity": 1, "Position": null, "Name": "Lager Beers", "Link": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b", "LinkEncoded": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b", "Map": "c", "Value": "Lager-Beers", "Children": [] } ], "items": { "type": "object", "example": { "Id": 2, "Quantity": 1, "Position": null, "Name": "Lager Beers", "Link": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b", "LinkEncoded": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b", "Map": "c", "Value": "Lager-Beers", "Children": [] }, "required": [ "Id", "Quantity", "Position", "Name", "Link", "LinkEncoded", "Map", "Value", "Children" ], "properties": { "Id": { "type": "integer", "description": "Category ID.", "example": 1 }, "Quantity": { "type": "integer", "description": "Quantity of the facets.", "example": 4 }, "Position": { "type": "integer", "description": "Position of the facet.", "nullable": true, "example": 1 }, "Name": { "type": "string", "description": "Category name.", "example": "Beers Beers Mesmo" }, "Link": { "type": "string", "description": "Link of the facet.", "example": "/Beers-Beers-Mesmo/1?map=c,b" }, "LinkEncoded": { "type": "string", "description": "Encoded link of the facet.", "example": "/Beers-Beers-Mesmo/1?map=c,b" }, "Map": { "type": "string", "description": "Mapping of the facet.", "example": "c" }, "Value": { "type": "string", "description": "Value of the facet.", "example": "Beers-Beers-Mesmo" }, "Children": { "type": "array", "description": "Category children.", "example": [] } } } } } } }, "PriceRanges": { "type": "array", "description": "Array with general information of the price ranges.", "example": [] }, "Summary": { "type": "object", "description": "Summary of the facets.", "example": { "Departments": { "DisplayedItems": 8, "TotalItems": 8 }, "CategoriesTrees": { "DisplayedItems": 13, "TotalItems": 13 }, "Brands": { "DisplayedItems": 10, "TotalItems": 10 }, "PriceRanges": { "DisplayedItems": 0, "TotalItems": 0 }, "SpecificationFilters": {} }, "required": [ "Departments", "CategoriesTrees", "Brands", "PriceRanges", "SpecificationFilters" ], "properties": { "Departments": { "type": "object", "description": "Departments' quantity of displayed and total items.", "example": { "DisplayedItems": 8, "TotalItems": 8 }, "required": [ "DisplayedItems", "TotalItems" ], "properties": { "DisplayedItems": { "type": "integer", "description": "Quantity of displayed items.", "example": 8 }, "TotalItems": { "type": "integer", "description": "Quantity of total items.", "example": 8 } } }, "CategoriesTrees": { "type": "object", "description": "Category tree's quantity of displayed and total items.", "example": { "DisplayedItems": 13, "TotalItems": 13 }, "required": [ "DisplayedItems", "TotalItems" ], "properties": { "DisplayedItems": { "type": "integer", "description": "Quantity of displayed items.", "example": 13 }, "TotalItems": { "type": "integer", "description": "Quantity of total items.", "example": 13 } } }, "Brands": { "type": "object", "description": "Brands' quantity of displayed and total items.", "example": { "DisplayedItems": 10, "TotalItems": 10 }, "required": [ "DisplayedItems", "TotalItems" ], "properties": { "DisplayedItems": { "type": "integer", "description": "Quantity of displayed items.", "example": 10 }, "TotalItems": { "type": "integer", "description": "Quantity of total items.", "example": 10 } } }, "PriceRanges": { "type": "object", "description": "Price ranges' quantity of displayed and total items.", "example": { "DisplayedItems": 0, "TotalItems": 0 }, "required": [ "DisplayedItems", "TotalItems" ], "properties": { "DisplayedItems": { "type": "integer", "description": "Quantity of displayed items.", "example": 0 }, "TotalItems": { "type": "integer", "description": "Quantity of total items.", "example": 0 } } }, "SpecificationFilters": { "type": "object", "description": "Specification filters' quantity of displayed and total items.", "example": {} } } } } }, "example": { "Departments": [ { "Quantity": 2, "Position": null, "Name": "Beers Beers Mesmo", "Link": "/Beers-Beers-Mesmo/1?map=c,b", "LinkEncoded": "/Beers-Beers-Mesmo/1?map=c,b", "Map": "c", "Value": "Beers-Beers-Mesmo" }, { "Quantity": 2, "Position": null, "Name": "Merch Integration Category ||", "Link": "/Merch-Integration-Category-||/1?map=c,b", "LinkEncoded": "/Merch-Integration-Category-%7C%7C/1?map=c,b", "Map": "c", "Value": "Merch-Integration-Category-||" }, { "Quantity": 1, "Position": null, "Name": "Jogos", "Link": "/Jogos/1?map=c,b", "LinkEncoded": "/Jogos/1?map=c,b", "Map": "c", "Value": "Jogos" }, { "Quantity": 3, "Position": null, "Name": "189", "Link": "/189/1?map=c,b", "LinkEncoded": "/189/1?map=c,b", "Map": "c", "Value": "189" }, { "Quantity": 1, "Position": null, "Name": "Tests", "Link": "/Tests/1?map=c,b", "LinkEncoded": "/Tests/1?map=c,b", "Map": "c", "Value": "Tests" }, { "Quantity": 1, "Position": null, "Name": "Accessories", "Link": "/Accessories/1?map=c,b", "LinkEncoded": "/Accessories/1?map=c,b", "Map": "c", "Value": "Accessories" }, { "Quantity": 2, "Position": null, "Name": "Bars", "Link": "/Bars/1?map=c,b", "LinkEncoded": "/Bars/1?map=c,b", "Map": "c", "Value": "Bars" }, { "Quantity": 5, "Position": null, "Name": "Categoria Teste Timeout", "Link": "/Categoria-Teste-Timeout/1?map=c,b", "LinkEncoded": "/Categoria-Teste-Timeout/1?map=c,b", "Map": "c", "Value": "Categoria-Teste-Timeout" } ], "Brands": [ { "Quantity": 2, "Position": null, "Name": "Merch XP", "Link": "/1/1234600/1/Merch-XP?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Merch-XP?map=c,c,b,b", "Map": "b", "Value": "Merch-XP" }, { "Quantity": 2, "Position": null, "Name": "Zé", "Link": "/1/1234600/1/Ze?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Ze?map=c,c,b,b", "Map": "b", "Value": "Ze" }, { "Quantity": 1, "Position": null, "Name": "Odin", "Link": "/1/1234600/1/Odin?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Odin?map=c,c,b,b", "Map": "b", "Value": "Odin" }, { "Quantity": 2, "Position": null, "Name": "Hoegaarden", "Link": "/1/1234600/1/Hoegaarden?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Hoegaarden?map=c,c,b,b", "Map": "b", "Value": "Hoegaarden" }, { "Quantity": 1, "Position": null, "Name": "Teste marcas", "Link": "/1/1234600/1/Teste-marcas?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Teste-marcas?map=c,c,b,b", "Map": "b", "Value": "Teste-marcas" }, { "Quantity": 1, "Position": null, "Name": "Bitmap Bureau", "Link": "/1/1234600/1/Bitmap-Bureau?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Bitmap-Bureau?map=c,c,b,b", "Map": "b", "Value": "Bitmap-Bureau" }, { "Quantity": 1, "Position": null, "Name": "Sega", "Link": "/1/1234600/1/Sega?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Sega?map=c,c,b,b", "Map": "b", "Value": "Sega" }, { "Quantity": 3, "Position": null, "Name": "Technogym", "Link": "/1/1234600/1/Technogym?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Technogym?map=c,c,b,b", "Map": "b", "Value": "Technogym" }, { "Quantity": 3, "Position": null, "Name": "Aptany", "Link": "/1/1234600/1/Aptany?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Aptany?map=c,c,b,b", "Map": "b", "Value": "Aptany" }, { "Quantity": 1, "Position": null, "Name": "Tectoy", "Link": "/1/1234600/1/Tectoy?map=c,c,b,b", "LinkEncoded": "/1/1234600/1/Tectoy?map=c,c,b,b", "Map": "b", "Value": "Tectoy" } ], "SpecificationFilters": {}, "CategoriesTrees": [ { "Id": 1, "Quantity": 4, "Position": null, "Name": "Beers Beers Mesmo", "Link": "/Beers-Beers-Mesmo/1?map=c,b", "LinkEncoded": "/Beers-Beers-Mesmo/1?map=c,b", "Map": "c", "Value": "Beers-Beers-Mesmo", "Children": [ { "Id": 2, "Quantity": 1, "Position": null, "Name": "Lager Beers", "Link": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b", "LinkEncoded": "/Beers-Beers-Mesmo/Lager-Beers/1?map=c,c,b", "Map": "c", "Value": "Lager-Beers", "Children": [] } ] }, { "Id": 1234571, "Quantity": 2, "Position": null, "Name": "Jogos", "Link": "/Jogos/1?map=c,b", "LinkEncoded": "/Jogos/1?map=c,b", "Map": "c", "Value": "Jogos", "Children": [] }, { "Id": 1234579, "Quantity": 3, "Position": null, "Name": "189", "Link": "/189/1?map=c,b", "LinkEncoded": "/189/1?map=c,b", "Map": "c", "Value": "189", "Children": [] }, { "Id": 1234587, "Quantity": 1, "Position": null, "Name": "Tests", "Link": "/Tests/1?map=c,b", "LinkEncoded": "/Tests/1?map=c,b", "Map": "c", "Value": "Tests", "Children": [] }, { "Id": 1234595, "Quantity": 1, "Position": null, "Name": "Accessories", "Link": "/Accessories/1?map=c,b", "LinkEncoded": "/Accessories/1?map=c,b", "Map": "c", "Value": "Accessories", "Children": [ { "Id": 1234596, "Quantity": 1, "Position": null, "Name": "Foam rollers", "Link": "/Accessories/Foam-rollers/1?map=c,c,b", "LinkEncoded": "/Accessories/Foam-rollers/1?map=c,c,b", "Map": "c", "Value": "Foam-rollers", "Children": [] } ] }, { "Id": 1234597, "Quantity": 2, "Position": null, "Name": "Bars", "Link": "/Bars/1?map=c,b", "LinkEncoded": "/Bars/1?map=c,b", "Map": "c", "Value": "Bars", "Children": [ { "Id": 1234598, "Quantity": 1, "Position": null, "Name": "Training Bars", "Link": "/Bars/Training-Bars/1?map=c,c,b", "LinkEncoded": "/Bars/Training-Bars/1?map=c,c,b", "Map": "c", "Value": "Training-Bars", "Children": [] }, { "Id": 1234599, "Quantity": 1, "Position": null, "Name": "Curl Bars", "Link": "/Bars/Curl-Bars/1?map=c,c,b", "LinkEncoded": "/Bars/Curl-Bars/1?map=c,c,b", "Map": "c", "Value": "Curl-Bars", "Children": [] } ] }, { "Id": 15, "Quantity": 1, "Position": null, "Name": "Coronas", "Link": "/Coronas/1?map=c,b", "LinkEncoded": "/Coronas/1?map=c,b", "Map": "c", "Value": "Coronas", "Children": [ { "Id": 13, "Quantity": 1, "Position": null, "Name": "não tem limite!", "Link": "/Coronas/nao-tem-limite-/1?map=c,c,b", "LinkEncoded": "/Coronas/nao-tem-limite-/1?map=c,c,b", "Map": "c", "Value": "nao-tem-limite-", "Children": [] } ] }, { "Id": 4, "Quantity": 4, "Position": null, "Name": "Merch Integration Category ||", "Link": "/Merch-Integration-Category-||/1?map=c,b", "LinkEncoded": "/Merch-Integration-Category-%7C%7C/1?map=c,b", "Map": "c", "Value": "Merch-Integration-Category-||", "Children": [] } ], "PriceRanges": [], "Summary": { "Departments": { "DisplayedItems": 8, "TotalItems": 8 }, "CategoriesTrees": { "DisplayedItems": 13, "TotalItems": 13 }, "Brands": { "DisplayedItems": 10, "TotalItems": 10 }, "PriceRanges": { "DisplayedItems": 0, "TotalItems": 0 }, "SpecificationFilters": {} } } } } } } } }, "/buscaautocomplete": { "get": { "tags": [ "Autocomplete" ], "summary": "Product search autocomplete", "description": "Retrieves product's information related to the searched string.\r\n`{{searchString}} is the part of string the user is looking for.\r\nE.g.: `ref` | `refrig` | `refrigerator`", "operationId": "AutoComplete", "parameters": [ { "name": "Content-Type", "in": "header", "description": "Type of the content being sent", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand ", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, { "name": "productNameContains", "in": "query", "description": "Part of the string that will be searched.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "jeans" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "The root schema comprises the entire JSON document.", "example": { "itemsReturned": [ { "items": [], "thumb": "", "thumbUrl": null, "name": "Cacilds in Coronas", "href": "https://merch.vtexcommercestable.com.br/coronas/Cacilds", "criteria": "£Cacilds in Coronas¢/coronas/Cacilds" }, { "items": [ { "productId": "3", "itemId": "5", "name": "Llf", "nameComplete": "Cacilds Llf", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/172754-25-25/Diablo.jpg?v=637521970448770000" } ], "thumb": "\"image-433ec3e72d7e4b94964481e843c9dd88\"", "thumbUrl": "https://merch.vteximg.com.br/arquivos/ids/172754-25-25/Diablo.jpg?v=637521970448770000", "name": "cacilds - llf", "href": "https://merch.vtexcommercestable.com.br/bay-max-3/p", "criteria": null } ] }, "required": [ "itemsReturned" ], "properties": { "itemsReturned": { "type": "array", "description": "Autocomplete returned items.", "example": [ { "items": [], "thumb": "", "thumbUrl": null, "name": "Cacilds in Coronas", "href": "https://merch.vtexcommercestable.com.br/coronas/Cacilds", "criteria": "£Cacilds in Coronas¢/coronas/Cacilds" }, { "items": [ { "productId": "3", "itemId": "5", "name": "Llf", "nameComplete": "Cacilds Llf", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/172754-25-25/Diablo.jpg?v=637521970448770000" } ], "thumb": "\"image-433ec3e72d7e4b94964481e843c9dd88\"", "thumbUrl": "https://merch.vteximg.com.br/arquivos/ids/172754-25-25/Diablo.jpg?v=637521970448770000", "name": "cacilds - llf", "href": "https://merch.vtexcommercestable.com.br/bay-max-3/p", "criteria": null } ], "items": { "type": "object", "example": { "items": [], "thumb": "", "thumbUrl": null, "name": "Cacilds in Coronas", "href": "https://merch.vtexcommercestable.com.br/coronas/Cacilds", "criteria": "£Cacilds in Coronas¢/coronas/Cacilds" }, "required": [ "items", "thumb", "thumbUrl", "name", "href", "criteria" ], "properties": { "items": { "type": "array", "description": "Array of products.", "example": [ { "productId": "3", "itemId": "5", "name": "Llf", "nameComplete": "Cacilds Llf", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/172754-25-25/Diablo.jpg?v=637521970448770000" } ], "items":{ "type": "object", "description": "Product information.", "properties": { "productId": { "type": "string", "description": "Product ID.", "example": "1" }, "itemId": { "type": "string", "description": "Item ID.", "example": "3" }, "name": { "type": "string", "description": "Product name.", "example": "Meia" }, "nameComplete": { "type": "string", "description": "Complete product name.", "example": "Meia de Gatinho" }, "imageUrl": { "type": "string", "description": "Product image URL.", "example": "https://docstore.vteximg.com.br/arquivos/ids/155397-100-100/4636833666_e85dd0b065_b.jpg" } } } }, "thumb": { "type": "string", "description": "Item thumbnail.", "example": "\"image-433ec3e72d7e4b94964481e843c9dd88\"" }, "thumbUrl": { "type": "string", "description": "Item thumbnail URL.", "nullable": true, "example": "https://merch.vteximg.com.br/arquivos/ids/172754-25-25/Diablo.jpg?v=637521970448770000" }, "name": { "type": "string", "description": "Item name.", "example": "cacilds - llf" }, "href": { "type": "string", "description": "Item URL.", "example": "https://merch.vtexcommercestable.com.br/bay-max-3/p" }, "criteria": { "type": "string", "description": "Item criteria.", "nullable": true, "example": "£Cacilds in Coronas¢/coronas/Cacilds" } } } } } }, "example": { "itemsReturned": [ { "items": [], "thumb": "", "thumbUrl": null, "name": "Cacilds in Coronas", "href": "https://merch.vtexcommercestable.com.br/coronas/Cacilds", "criteria": "£Cacilds in Coronas¢/coronas/Cacilds" }, { "items": [ { "productId": "3", "itemId": "5", "name": "Llf", "nameComplete": "Cacilds Llf", "imageUrl": "https://merch.vteximg.com.br/arquivos/ids/172754-25-25/Diablo.jpg?v=637521970448770000" } ], "thumb": "\"image-433ec3e72d7e4b94964481e843c9dd88\"", "thumbUrl": "https://merch.vteximg.com.br/arquivos/ids/172754-25-25/Diablo.jpg?v=637521970448770000", "name": "cacilds - llf", "href": "https://merch.vtexcommercestable.com.br/bay-max-3/p", "criteria": null } ] } } } } } } } }, "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "components": { "securitySchemes": { "appKey": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppKey", "description": "Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, "appToken": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppToken", "description": "Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, "VtexIdclientAutCookie": { "type": "apiKey", "in": "header", "name": "VtexIdclientAutCookie", "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours." } }, "schemas": { "Example": { "required": [ "productId", "productName", "brand", "linkText", "productReference", "categories", "link", "description", "items" ], "type": "object", "properties": { "productId": { "type": "string" }, "productName": { "type": "string" }, "brand": { "type": "string" }, "linkText": { "type": "string" }, "productReference": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "" }, "link": { "type": "string" }, "description": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Item" }, "description": "" } } }, "Item": { "required": [ "itemId", "name", "nameComplete", "complementName", "ean", "measurementUnit", "unitMultiplier", "images", "sellers" ], "type": "object", "properties": { "itemId": { "type": "string" }, "name": { "type": "string" }, "nameComplete": { "type": "string" }, "complementName": { "type": "string" }, "ean": { "type": "string" }, "referenceId": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceId" }, "description": "" }, "measurementUnit": { "type": "string" }, "unitMultiplier": { "type": "number" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/Image" }, "description": "" }, "sellers": { "type": "array", "items": { "$ref": "#/components/schemas/Seller" }, "description": "" }, "COR": { "type": "array", "items": { "type": "string" }, "description": "" }, "TAMANHO": { "type": "array", "items": { "type": "string" }, "description": "" }, "variations": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "ReferenceId": { "required": [ "Key", "Value" ], "type": "object", "properties": { "Key": { "type": "string" }, "Value": { "type": "string" } }, "example": { "Key": "RefId", "Value": "969697" } }, "Image": { "required": [ "imageId", "imageLabel", "imageTag", "imageUrl", "imageText" ], "type": "object", "properties": { "imageId": { "type": "string" }, "imageLabel": { "type": "string" }, "imageTag": { "type": "string" }, "imageUrl": { "type": "string" }, "imageText": { "type": "string", "nullable": true } }, "example": { "imageId": "168969", "imageLabel": "", "imageTag": "\"geladeira\"", "imageUrl": "http://ambienteqa.vteximg.com.br/arquivos/ids/168969/geladeira.jpg", "imageText": "geladeira" } }, "Seller": { "required": [ "sellerId", "sellerName", "addToCartLink", "sellerDefault", "commertialOffer" ], "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" }, "addToCartLink": { "type": "string" }, "sellerDefault": { "type": "boolean" }, "commertialOffer": { "$ref": "#/components/schemas/CommertialOffer" } } }, "CommertialOffer": { "required": [ "DeliverySlaSamplesPerRegion", "Installments", "DiscountHighLight", "GiftSkuIds", "Teasers", "BuyTogether", "Price", "ListPrice", "PriceValidUntil", "AvailableQuantity", "Tax", "DeliverySlaSamples", "GetInfoErrorMessage", "CacheVersionUsedToCallCheckout" ], "type": "object", "properties": { "DeliverySlaSamplesPerRegion": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/generatedObject" } }, "Installments": { "type": "array", "items": { "$ref": "#/components/schemas/Installment" }, "description": "" }, "DiscountHighLight": { "type": "array", "items": { "type": "string" }, "description": "" }, "GiftSkuIds": { "type": "array", "items": { "type": "string" }, "description": "" }, "Teasers": { "type": "array", "description": "List with promotions teasers.", "example": [ { "k__BackingField": "TesteInfoAdicional", "k__BackingField": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "k__BackingField": { "k__BackingField": 0, "k__BackingField": [ { "k__BackingField": "PaymentMethodId", "k__BackingField": "4" } ] }, "k__BackingField": { "k__BackingField": [ { "k__BackingField": "PercentualDiscount", "k__BackingField": "1" } ] } } ], "items": { "type": "object", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}.", "properties": { "{field}": { "type": "string", "example": "{value}" } } }, "k__BackingField": { "type": "object", "description": "Conditions.", "properties": { "k__BackingField": { "type": "integer", "description": "Minimum quantity." }, "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } }, "k__BackingField": { "type": "object", "description": "Effects.", "properties": { "k__BackingField": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "k__BackingField": { "type": "string", "description": "Name." }, "k__BackingField": { "type": "string", "description": "Value." } } } } } } } } }, "PromotionTeasers": { "type": "array", "description": "List with promotions teasers.", "example": [ { "Name": "TesteInfoAdicional", "GeneralValues": { "Time": "Flamengo", "Nome": "Pedro", "Camisa": "9" }, "Conditions": { "MinimumQuantity": 0, "Parameters": [ { "Name": "PaymentMethodId", "Value": "4" } ] }, "Effects": { "Parameters": [ { "Name": "PercentualDiscount", "Value": "1" } ] } } ], "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name." }, "GeneralValues": { "type": "object", "description": "General values. Each property follows the format: `{field}:{value}.", "properties": { "{field}": { "type": "string", "example": "{value}" } } }, "Conditions": { "type": "object", "description": "Conditions.", "properties": { "MinimumQuantity": { "type": "integer", "description": "Minimum quantity." }, "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } }, "Effects": { "type": "object", "description": "Effects.", "properties": { "Parameters": { "type": "array", "description": "Parameters.", "items": { "type": "object", "description": "Parameter.", "properties": { "Name": { "type": "string", "description": "Name." }, "Value": { "type": "string", "description": "Value." } } } } } } } } }, "BuyTogether": { "type": "array", "items": { "type": "string" }, "description": "" }, "Price": { "type": "number" }, "ListPrice": { "type": "number" }, "PriceValidUntil": { "type": "string" }, "AvailableQuantity": { "type": "integer", "format": "int32" }, "Tax": { "type": "number" }, "DeliverySlaSamples": { "type": "array", "items": { "$ref": "#/components/schemas/DeliverySlaSample" }, "description": "" }, "GetInfoErrorMessage": { "type": "string", "nullable": true }, "CacheVersionUsedToCallCheckout": { "type": "string" } } }, "generatedObject": { "required": [ "DeliverySlaPerTypes", "Region" ], "type": "object", "properties": { "DeliverySlaPerTypes": { "type": "array", "items": { "$ref": "#/components/schemas/DeliverySlaPerType" }, "description": "" }, "Region": { "$ref": "#/components/schemas/Region" } }, "example": { "DeliverySlaPerTypes": [ { "TypeName": "Econômica", "Price": 4.11, "EstimatedTimeSpanToDelivery": "00:00:00" }, { "TypeName": "n2_2", "Price": 6.5, "EstimatedTimeSpanToDelivery": "00:00:00" }, { "TypeName": "Normal", "Price": 6.5, "EstimatedTimeSpanToDelivery": "00:00:00" }, { "TypeName": "P_T", "Price": 156.5, "EstimatedTimeSpanToDelivery": "00:00:00" } ], "Region": { "IsPersisted": true, "IsRemoved": false, "Id": 1, "Name": "Rio", "CountryCode": "BRA", "ZipCode": "22011050", "CultureInfoName": "pt-BR" } } }, "DeliverySlaPerType": { "required": [ "TypeName", "Price", "EstimatedTimeSpanToDelivery" ], "type": "object", "properties": { "TypeName": { "type": "string" }, "Price": { "type": "number" }, "EstimatedTimeSpanToDelivery": { "type": "string" } }, "example": { "TypeName": "Econômica", "Price": 4.11, "EstimatedTimeSpanToDelivery": "00:00:00" } }, "Region": { "nullable": true, "required": [ "IsPersisted", "IsRemoved", "Id", "Name", "CountryCode", "ZipCode", "CultureInfoName" ], "type": "object", "properties": { "IsPersisted": { "type": "boolean" }, "IsRemoved": { "type": "boolean" }, "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "CountryCode": { "type": "string" }, "ZipCode": { "type": "string" }, "CultureInfoName": { "type": "string" } }, "example": { "IsPersisted": true, "IsRemoved": false, "Id": 1, "Name": "Rio", "CountryCode": "BRA", "ZipCode": "22011050", "CultureInfoName": "pt-BR" } }, "Installment": { "required": [ "Value", "InterestRate", "TotalValuePlusInterestRate", "NumberOfInstallments", "PaymentSystemName", "PaymentSystemGroupName", "Name" ], "type": "object", "properties": { "Value": { "type": "number" }, "InterestRate": { "type": "number" }, "TotalValuePlusInterestRate": { "type": "number" }, "NumberOfInstallments": { "type": "integer", "format": "int32" }, "PaymentSystemName": { "type": "string" }, "PaymentSystemGroupName": { "type": "string" }, "Name": { "type": "string" } }, "example": { "Value": 1000, "InterestRate": 0, "TotalValuePlusInterestRate": 1000, "NumberOfInstallments": 1, "PaymentSystemName": "American Express", "PaymentSystemGroupName": "creditCardPaymentGroup", "Name": "American Express à vista" } }, "DeliverySlaSample": { "required": [ "DeliverySlaPerTypes", "Region" ], "type": "object", "properties": { "DeliverySlaPerTypes": { "type": "array", "items": { "$ref": "#/components/schemas/DeliverySlaPerType2" }, "description": "" }, "Region": { "$ref": "#/components/schemas/Region2" } }, "example": { "DeliverySlaPerTypes": [], "Region": null } }, "DeliverySlaPerType2": { "type": "object", "properties": { "TypeName": { "type": "string" }, "Price": { "type": "number" }, "EstimatedTimeSpanToDelivery": { "type": "string" } } }, "Region2": { "type": "object", "nullable": true, "properties": { "IsPersisted": { "type": "boolean" }, "IsRemoved": { "type": "boolean" }, "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "CountryCode": { "type": "string" }, "ZipCode": { "type": "string" }, "CultureInfoName": { "type": "string" } } }, "Example2": { "required": [ "Departments", "Brands", "SpecificationFilters", "CategoriesTrees" ], "type": "object", "properties": { "Departments": { "type": "array", "items": { "$ref": "#/components/schemas/Department" }, "description": "" }, "Brands": { "type": "array", "items": { "$ref": "#/components/schemas/Brand" }, "description": "" }, "SpecificationFilters": { "$ref": "#/components/schemas/SpecificationFilters" }, "CategoriesTrees": { "type": "array", "items": { "$ref": "#/components/schemas/CategoriesTree" }, "description": "" } }, "example": { "Departments": [ { "Quantity": 20, "Name": "Eletro-Eletronicos", "Link": "/Eletro-Eletronicos" } ], "Brands": [ { "Quantity": 1, "Name": "Philips", "Link": "/eletronicos/tv/Philips" }, { "Quantity": 5, "Name": "Samsung", "Link": "/eletronicos/tv/Samsung" }, { "Quantity": 6, "Name": "Philco", "Link": "/eletronicos/tv/Philco" }, { "Quantity": 2, "Name": "AOC", "Link": "/eletronicos/tv/AOC" }, { "Quantity": 1, "Name": "Semp", "Link": "/eletronicos/tv/Semp" }, { "Quantity": 2, "Name": "Toshiba", "Link": "/eletronicos/tv/Toshiba" }, { "Quantity": 3, "Name": "TCL", "Link": "/eletronicos/tv/TCL" } ], "SpecificationFilters": { "Resolução": [ { "Quantity": 10, "Name": "Full-HD", "Link": "/eletronicos/tv/Full-HD?map=c,c,specificationFilter_73" }, { "Quantity": 7, "Name": "HD-Ready", "Link": "/eletronicos/tv/HD-Ready?map=c,c,specificationFilter_73" }, { "Quantity": 2, "Name": "Ultra-HD", "Link": "/eletronicos/tv/Ultra-HD?map=c,c,specificationFilter_73" } ], "Tamanho da Tela": [ { "Quantity": 3, "Name": "Acima de 51 pol.", "Link": "/eletronicos/tv/Acima de 51 pol.?map=c,c,specificationFilter_74" }, { "Quantity": 1, "Name": "Até 19 pol.", "Link": "/eletronicos/tv/Até 19 pol.?map=c,c,specificationFilter_74" }, { "Quantity": 2, "Name": "De 20 a 29 pol.", "Link": "/eletronicos/tv/De 20 a 29 pol.?map=c,c,specificationFilter_74" }, { "Quantity": 5, "Name": "De 30 a 39 pol.", "Link": "/eletronicos/tv/De 30 a 39 pol.?map=c,c,specificationFilter_74" }, { "Quantity": 8, "Name": "De 40 a 51 pol.", "Link": "/eletronicos/tv/De 40 a 51 pol.?map=c,c,specificationFilter_74" } ], "Aplicativos de TV": [ { "Quantity": 4, "Name": "Crackle", "Link": "/eletronicos/tv/Crackle?map=c,c,specificationFilter_1517" }, { "Quantity": 12, "Name": "NetFlix", "Link": "/eletronicos/tv/NetFlix?map=c,c,specificationFilter_1517" }, { "Quantity": 4, "Name": "NetMovies", "Link": "/eletronicos/tv/NetMovies?map=c,c,specificationFilter_1517" }, { "Quantity": 4, "Name": "Vimeo", "Link": "/eletronicos/tv/Vimeo?map=c,c,specificationFilter_1517" }, { "Quantity": 13, "Name": "YouTube", "Link": "/eletronicos/tv/YouTube?map=c,c,specificationFilter_1517" } ] }, "CategoriesTrees": [ { "Quantity": 20, "Name": "Eletrônicos", "Link": "/Eletronicos", "Children": [ { "Quantity": 20, "Name": "TV", "Link": "/Eletronicos/TV", "Children": [ { "Quantity": 6, "Name": "TV LED", "Link": "/Eletronicos/TV/TV-LED", "Children": [] }, { "Quantity": 14, "Name": "Smart TV", "Link": "/Eletronicos/TV/Smart-TV", "Children": [] } ] } ] } ] } }, "Department": { "required": [ "Quantity", "Name", "Link" ], "type": "object", "properties": { "Quantity": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Link": { "type": "string" } }, "example": { "Quantity": 20, "Name": "Eletro-Eletronicos", "Link": "/Eletro-Eletronicos" } }, "Brand": { "required": [ "Quantity", "Name", "Link" ], "type": "object", "properties": { "Quantity": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Link": { "type": "string" } }, "example": { "Quantity": 1, "Name": "Philips", "Link": "/eletronicos/tv/Philips" } }, "SpecificationFilters": { "required": [ "Resolução", "Tamanho da Tela", "Aplicativos de TV" ], "type": "object", "properties": { "Resolução": { "type": "array", "items": { "$ref": "#/components/schemas/ResoluO" }, "description": "" }, "Tamanho da Tela": { "type": "array", "items": { "$ref": "#/components/schemas/TamanhoDaTela" }, "description": "" }, "Aplicativos de TV": { "type": "array", "items": { "$ref": "#/components/schemas/AplicativosDeTV" }, "description": "" } }, "example": { "Resolução": [ { "Quantity": 10, "Name": "Full-HD", "Link": "/eletronicos/tv/Full-HD?map=c,c,specificationFilter_73" }, { "Quantity": 7, "Name": "HD-Ready", "Link": "/eletronicos/tv/HD-Ready?map=c,c,specificationFilter_73" }, { "Quantity": 2, "Name": "Ultra-HD", "Link": "/eletronicos/tv/Ultra-HD?map=c,c,specificationFilter_73" } ], "Tamanho da Tela": [ { "Quantity": 3, "Name": "Acima de 51 pol.", "Link": "/eletronicos/tv/Acima de 51 pol.?map=c,c,specificationFilter_74" }, { "Quantity": 1, "Name": "Até 19 pol.", "Link": "/eletronicos/tv/Até 19 pol.?map=c,c,specificationFilter_74" }, { "Quantity": 2, "Name": "De 20 a 29 pol.", "Link": "/eletronicos/tv/De 20 a 29 pol.?map=c,c,specificationFilter_74" }, { "Quantity": 5, "Name": "De 30 a 39 pol.", "Link": "/eletronicos/tv/De 30 a 39 pol.?map=c,c,specificationFilter_74" }, { "Quantity": 8, "Name": "De 40 a 51 pol.", "Link": "/eletronicos/tv/De 40 a 51 pol.?map=c,c,specificationFilter_74" } ], "Aplicativos de TV": [ { "Quantity": 4, "Name": "Crackle", "Link": "/eletronicos/tv/Crackle?map=c,c,specificationFilter_1517" }, { "Quantity": 12, "Name": "NetFlix", "Link": "/eletronicos/tv/NetFlix?map=c,c,specificationFilter_1517" }, { "Quantity": 4, "Name": "NetMovies", "Link": "/eletronicos/tv/NetMovies?map=c,c,specificationFilter_1517" }, { "Quantity": 4, "Name": "Vimeo", "Link": "/eletronicos/tv/Vimeo?map=c,c,specificationFilter_1517" }, { "Quantity": 13, "Name": "YouTube", "Link": "/eletronicos/tv/YouTube?map=c,c,specificationFilter_1517" } ] } }, "ResoluO": { "required": [ "Quantity", "Name", "Link" ], "type": "object", "properties": { "Quantity": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Link": { "type": "string" } }, "example": { "Quantity": 10, "Name": "Full-HD", "Link": "/eletronicos/tv/Full-HD?map=c,c,specificationFilter_73" } }, "TamanhoDaTela": { "required": [ "Quantity", "Name", "Link" ], "type": "object", "properties": { "Quantity": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Link": { "type": "string" } }, "example": { "Quantity": 3, "Name": "Acima de 51 pol.", "Link": "/eletronicos/tv/Acima de 51 pol.?map=c,c,specificationFilter_74" } }, "AplicativosDeTV": { "required": [ "Quantity", "Name", "Link" ], "type": "object", "properties": { "Quantity": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Link": { "type": "string" } }, "example": { "Quantity": 4, "Name": "Crackle", "Link": "/eletronicos/tv/Crackle?map=c,c,specificationFilter_1517" } }, "CategoriesTree": { "required": [ "Quantity", "Name", "Link", "Children" ], "type": "object", "properties": { "Quantity": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Link": { "type": "string" }, "Children": { "type": "array", "items": { "$ref": "#/components/schemas/Child" }, "description": "" } }, "example": { "Quantity": 20, "Name": "Eletrônicos", "Link": "/Eletronicos", "Children": [ { "Quantity": 20, "Name": "TV", "Link": "/Eletronicos/TV", "Children": [ { "Quantity": 6, "Name": "TV LED", "Link": "/Eletronicos/TV/TV-LED", "Children": [] }, { "Quantity": 14, "Name": "Smart TV", "Link": "/Eletronicos/TV/Smart-TV", "Children": [] } ] } ] } }, "Child": { "required": [ "Quantity", "Name", "Link", "Children" ], "type": "object", "properties": { "Quantity": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Link": { "type": "string" }, "Children": { "type": "array", "items": { "$ref": "#/components/schemas/Child1" }, "description": "" } }, "example": { "Quantity": 20, "Name": "TV", "Link": "/Eletronicos/TV", "Children": [ { "Quantity": 6, "Name": "TV LED", "Link": "/Eletronicos/TV/TV-LED", "Children": [] }, { "Quantity": 14, "Name": "Smart TV", "Link": "/Eletronicos/TV/Smart-TV", "Children": [] } ] } }, "Child1": { "required": [ "Quantity", "Name", "Link", "Children" ], "type": "object", "properties": { "Quantity": { "type": "integer", "format": "int32" }, "Name": { "type": "string" }, "Link": { "type": "string" }, "Children": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "Quantity": 6, "Name": "TV LED", "Link": "/Eletronicos/TV/TV-LED", "Children": [] } }, "Example3": { "required": [ "itemsReturned" ], "type": "object", "properties": { "itemsReturned": { "type": "array", "items": { "$ref": "#/components/schemas/ItemsReturned" }, "description": "" } }, "example": { "itemsReturned": [ { "thumb": "", "name": "geladeira em Departamento 8", "href": "https://ambienteqa.vtexcommercestable.com.br/departamento-8/geladeira", "criteria": "£geladeira em Departamento 8¢/departamento-8/geladeira" }, { "thumb": "", "name": "geladeira em Eletrodoméstico", "href": "https://ambienteqa.vtexcommercestable.com.br/eletrodomestico/geladeira", "criteria": "£geladeira em Eletrodoméstico¢/eletrodomestico/geladeira" }, { "thumb": "\"geladeira\"", "name": "geladeira eli", "href": "https://ambienteqa.vtexcommercestable.com.br/geladeiraeli/p", "criteria": null }, { "thumb": "\"gela\"", "name": "pre venda geladeira", "href": "https://ambienteqa.vtexcommercestable.com.br/prevendageladeira/p", "criteria": null }, { "thumb": "\"geladeira\"", "name": "geladeira", "href": "https://ambienteqa.vtexcommercestable.com.br/geladeira/p", "criteria": null } ] } }, "ItemsReturned": { "required": [ "thumb", "name", "href", "criteria" ], "type": "object", "properties": { "thumb": { "type": "string" }, "name": { "type": "string" }, "href": { "type": "string" }, "criteria": { "type": "string", "nullable": true } }, "example": { "thumb": "", "name": "geladeira em Departamento 8", "href": "https://ambienteqa.vtexcommercestable.com.br/departamento-8/geladeira", "criteria": "£geladeira em Departamento 8¢/departamento-8/geladeira" } } } }, "tags": [ { "name": "CrossSelling" }, { "name": "Search" }, { "name": "Offers" }, { "name": "Facets" }, { "name": "Autocomplete" } ] }